@shopify/ui-extensions 2026.4.0-rc.3 → 2026.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/surfaces/checkout/preact/api.js +2 -0
- package/build/cjs/surfaces/checkout/preact/app-metafields.js +1 -0
- package/build/cjs/surfaces/checkout/preact/attributes.js +3 -0
- package/build/cjs/surfaces/checkout/preact/billing-address.js +1 -0
- package/build/cjs/surfaces/checkout/preact/buyer-identity.js +4 -0
- package/build/cjs/surfaces/checkout/preact/buyer-journey.js +5 -0
- package/build/cjs/surfaces/checkout/preact/capabilities.js +2 -0
- package/build/cjs/surfaces/checkout/preact/cart-line-target.js +1 -0
- package/build/cjs/surfaces/checkout/preact/cart-lines.js +2 -0
- package/build/cjs/surfaces/checkout/preact/checkout-settings.js +1 -0
- package/build/cjs/surfaces/checkout/preact/checkout-token.js +1 -0
- package/build/cjs/surfaces/checkout/preact/cost.js +4 -0
- package/build/cjs/surfaces/checkout/preact/country.js +1 -0
- package/build/cjs/surfaces/checkout/preact/currency.js +1 -0
- package/build/cjs/surfaces/checkout/preact/customer-privacy.js +1 -0
- package/build/cjs/surfaces/checkout/preact/delivery-group-list-target.js +1 -0
- package/build/cjs/surfaces/checkout/preact/delivery-group-target.js +1 -0
- package/build/cjs/surfaces/checkout/preact/delivery-group.js +1 -0
- package/build/cjs/surfaces/checkout/preact/delivery-groups.js +1 -0
- package/build/cjs/surfaces/checkout/preact/delivery-selection-groups.js +1 -0
- package/build/cjs/surfaces/checkout/preact/discounts.js +3 -0
- package/build/cjs/surfaces/checkout/preact/extension-editor.js +1 -0
- package/build/cjs/surfaces/checkout/preact/extension-language.js +1 -0
- package/build/cjs/surfaces/checkout/preact/extension.js +2 -0
- package/build/cjs/surfaces/checkout/preact/gift-cards.js +2 -0
- package/build/cjs/surfaces/checkout/preact/instructions.js +1 -0
- package/build/cjs/surfaces/checkout/preact/language.js +1 -0
- package/build/cjs/surfaces/checkout/preact/localized-fields.js +2 -0
- package/build/cjs/surfaces/checkout/preact/market.js +1 -0
- package/build/cjs/surfaces/checkout/preact/metafields.js +1 -0
- package/build/cjs/surfaces/checkout/preact/note.js +2 -0
- package/build/cjs/surfaces/checkout/preact/payment-method.js +3 -0
- package/build/cjs/surfaces/checkout/preact/payment-options.js +2 -0
- package/build/cjs/surfaces/checkout/preact/pickup-location-option-target.js +1 -0
- package/build/cjs/surfaces/checkout/preact/redeemable.js +1 -0
- package/build/cjs/surfaces/checkout/preact/session-token.js +1 -0
- package/build/cjs/surfaces/checkout/preact/settings.js +1 -0
- package/build/cjs/surfaces/checkout/preact/shipping-address.js +2 -0
- package/build/cjs/surfaces/checkout/preact/shipping-option-target.js +1 -0
- package/build/cjs/surfaces/checkout/preact/shop.js +1 -0
- package/build/cjs/surfaces/checkout/preact/storage.js +1 -0
- package/build/cjs/surfaces/checkout/preact/subscription.js +1 -0
- package/build/cjs/surfaces/checkout/preact/target.js +1 -0
- package/build/cjs/surfaces/checkout/preact/timezone.js +1 -0
- package/build/cjs/surfaces/checkout/preact/translate.js +1 -0
- package/build/cjs/surfaces/checkout/shared.js +3 -16
- package/build/cjs/surfaces/checkout/style/style.js +1 -0
- package/build/cjs/surfaces/point-of-sale/types/storage.js +4 -0
- package/build/esm/surfaces/checkout/preact/api.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/app-metafields.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/attributes.mjs +3 -0
- package/build/esm/surfaces/checkout/preact/billing-address.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/buyer-identity.mjs +4 -0
- package/build/esm/surfaces/checkout/preact/buyer-journey.mjs +5 -0
- package/build/esm/surfaces/checkout/preact/capabilities.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/cart-line-target.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/cart-lines.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/checkout-settings.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/checkout-token.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/cost.mjs +4 -0
- package/build/esm/surfaces/checkout/preact/country.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/currency.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/customer-privacy.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/delivery-group-list-target.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/delivery-group-target.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/delivery-group.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/delivery-groups.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/delivery-selection-groups.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/discounts.mjs +3 -0
- package/build/esm/surfaces/checkout/preact/extension-editor.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/extension-language.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/extension.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/gift-cards.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/instructions.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/language.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/localized-fields.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/market.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/metafields.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/note.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/payment-method.mjs +3 -0
- package/build/esm/surfaces/checkout/preact/payment-options.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/pickup-location-option-target.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/redeemable.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/session-token.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/settings.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/shipping-address.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/shipping-option-target.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/shop.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/storage.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/subscription.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/target.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/timezone.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/translate.mjs +1 -0
- package/build/esm/surfaces/checkout/shared.mjs +3 -16
- package/build/esm/surfaces/checkout/style/style.mjs +1 -0
- package/build/esm/surfaces/point-of-sale/types/storage.mjs +4 -0
- package/build/esnext/surfaces/checkout/preact/api.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/app-metafields.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/attributes.esnext +3 -0
- package/build/esnext/surfaces/checkout/preact/billing-address.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/buyer-identity.esnext +4 -0
- package/build/esnext/surfaces/checkout/preact/buyer-journey.esnext +5 -0
- package/build/esnext/surfaces/checkout/preact/capabilities.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/cart-line-target.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/cart-lines.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/checkout-settings.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/checkout-token.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/cost.esnext +4 -0
- package/build/esnext/surfaces/checkout/preact/country.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/currency.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/customer-privacy.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/delivery-group-list-target.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/delivery-group-target.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/delivery-group.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/delivery-groups.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/delivery-selection-groups.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/discounts.esnext +3 -0
- package/build/esnext/surfaces/checkout/preact/extension-editor.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/extension-language.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/extension.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/gift-cards.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/instructions.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/language.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/localized-fields.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/market.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/metafields.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/note.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/payment-method.esnext +3 -0
- package/build/esnext/surfaces/checkout/preact/payment-options.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/pickup-location-option-target.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/redeemable.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/session-token.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/settings.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/shipping-address.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/shipping-option-target.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/shop.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/storage.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/subscription.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/target.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/timezone.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/translate.esnext +1 -0
- package/build/esnext/surfaces/checkout/shared.esnext +3 -16
- package/build/esnext/surfaces/checkout/style/style.esnext +1 -0
- package/build/esnext/surfaces/point-of-sale/types/storage.esnext +4 -0
- package/build/ts/shared.d.ts +32 -12
- package/build/ts/shared.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/action/action.d.ts +1 -0
- package/build/ts/surfaces/admin/api/action/action.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/block/block.d.ts +2 -0
- package/build/ts/surfaces/admin/api/block/block.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/checkout-rules/launch-options.d.ts +7 -4
- package/build/ts/surfaces/admin/api/checkout-rules/launch-options.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/checkout-rules/metafields.d.ts +13 -7
- package/build/ts/surfaces/admin/api/checkout-rules/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/checkout-rules/validation-settings.d.ts +1 -0
- package/build/ts/surfaces/admin/api/checkout-rules/validation-settings.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.d.ts +3 -0
- package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/discount-function-settings.d.ts +1 -0
- package/build/ts/surfaces/admin/api/discount-function-settings/discount-function-settings.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts +7 -3
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/metafields.d.ts +13 -7
- package/build/ts/surfaces/admin/api/discount-function-settings/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/generated/generated.d.ts +62 -0
- package/build/ts/surfaces/admin/api/generated/generated.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api/intents/intent-render.d.ts +24 -0
- package/build/ts/surfaces/admin/api/intents/intent-render.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api/intents/intents.d.ts +44 -8
- package/build/ts/surfaces/admin/api/intents/intents.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/order-routing-rule/data.d.ts +5 -3
- package/build/ts/surfaces/admin/api/order-routing-rule/data.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/order-routing-rule/metafields.d.ts +8 -3
- package/build/ts/surfaces/admin/api/order-routing-rule/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.d.ts +1 -0
- package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/picker/picker.d.ts +15 -7
- package/build/ts/surfaces/admin/api/picker/picker.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/print-action/print-action.d.ts +1 -0
- package/build/ts/surfaces/admin/api/print-action/print-action.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts +4 -2
- package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.d.ts +4 -2
- package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/purchase-options-card-action.d.ts +1 -0
- package/build/ts/surfaces/admin/api/purchase-options-card-action.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/resource-picker/resource-picker.d.ts +36 -17
- package/build/ts/surfaces/admin/api/resource-picker/resource-picker.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/shared.d.ts +2 -0
- package/build/ts/surfaces/admin/api/shared.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/standard/standard-rendering.d.ts +3 -0
- package/build/ts/surfaces/admin/api/standard/standard-rendering.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/standard/standard.d.ts +4 -1
- package/build/ts/surfaces/admin/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/standard/storage.d.ts +4 -0
- package/build/ts/surfaces/admin/api/standard/storage.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api.d.ts +2 -0
- package/build/ts/surfaces/admin/api.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminAction.d.ts +6 -0
- package/build/ts/surfaces/admin/components/AdminBlock.d.ts +6 -0
- package/build/ts/surfaces/admin/components/AdminPrintAction.d.ts +6 -0
- package/build/ts/surfaces/admin/components/Avatar.d.ts +9 -0
- package/build/ts/surfaces/admin/components/Badge.d.ts +9 -0
- package/build/ts/surfaces/admin/components/Banner.d.ts +11 -0
- package/build/ts/surfaces/admin/components/Box.d.ts +14 -0
- package/build/ts/surfaces/admin/components/Button.d.ts +14 -0
- package/build/ts/surfaces/admin/components/ButtonGroup.d.ts +8 -0
- package/build/ts/surfaces/admin/components/Checkbox.d.ts +12 -1
- package/build/ts/surfaces/admin/components/Chip.d.ts +4 -2
- package/build/ts/surfaces/admin/components/Choice.d.ts +10 -2
- package/build/ts/surfaces/admin/components/ChoiceList.d.ts +12 -2
- package/build/ts/surfaces/admin/components/Clickable.d.ts +16 -4
- package/build/ts/surfaces/admin/components/ClickableChip.d.ts +11 -0
- package/build/ts/surfaces/admin/components/ColorField.d.ts +12 -0
- package/build/ts/surfaces/admin/components/ColorPicker.d.ts +9 -0
- package/build/ts/surfaces/admin/components/DateField.d.ts +11 -0
- package/build/ts/surfaces/admin/components/DatePicker.d.ts +10 -1
- package/build/ts/surfaces/admin/components/Divider.d.ts +7 -0
- package/build/ts/surfaces/admin/components/DropZone.d.ts +8 -4
- package/build/ts/surfaces/admin/components/EmailField.d.ts +12 -0
- package/build/ts/surfaces/admin/components/Form.d.ts +10 -0
- package/build/ts/surfaces/admin/components/FunctionSettings.d.ts +12 -0
- package/build/ts/surfaces/admin/components/Grid.d.ts +16 -0
- package/build/ts/surfaces/admin/components/GridItem.d.ts +15 -0
- package/build/ts/surfaces/admin/components/Heading.d.ts +8 -0
- package/build/ts/surfaces/admin/components/Icon.d.ts +6 -3
- package/build/ts/surfaces/admin/components/Image.d.ts +15 -0
- package/build/ts/surfaces/admin/components/Link.d.ts +13 -3
- package/build/ts/surfaces/admin/components/ListItem.d.ts +8 -0
- package/build/ts/surfaces/admin/components/Menu.d.ts +11 -0
- package/build/ts/surfaces/admin/components/Modal.d.ts +8 -4
- package/build/ts/surfaces/admin/components/MoneyField.d.ts +13 -0
- package/build/ts/surfaces/admin/components/NumberField.d.ts +12 -0
- package/build/ts/surfaces/admin/components/Option.d.ts +10 -2
- package/build/ts/surfaces/admin/components/OptionGroup.d.ts +10 -2
- package/build/ts/surfaces/admin/components/OrderedList.d.ts +8 -0
- package/build/ts/surfaces/admin/components/Page.d.ts +4 -2
- package/build/ts/surfaces/admin/components/Paragraph.d.ts +8 -0
- package/build/ts/surfaces/admin/components/PasswordField.d.ts +12 -0
- package/build/ts/surfaces/admin/components/QueryContainer.d.ts +8 -0
- package/build/ts/surfaces/admin/components/SearchField.d.ts +13 -1
- package/build/ts/surfaces/admin/components/Section.d.ts +9 -0
- package/build/ts/surfaces/admin/components/Select.d.ts +14 -2
- package/build/ts/surfaces/admin/components/Spinner.d.ts +7 -0
- package/build/ts/surfaces/admin/components/Stack.d.ts +16 -0
- package/build/ts/surfaces/admin/components/Switch.d.ts +12 -1
- package/build/ts/surfaces/admin/components/Table.d.ts +15 -0
- package/build/ts/surfaces/admin/components/TableBody.d.ts +8 -0
- package/build/ts/surfaces/admin/components/TableCell.d.ts +9 -0
- package/build/ts/surfaces/admin/components/TableHeader.d.ts +9 -0
- package/build/ts/surfaces/admin/components/TableHeaderRow.d.ts +8 -0
- package/build/ts/surfaces/admin/components/TableRow.d.ts +8 -0
- package/build/ts/surfaces/admin/components/Text.d.ts +19 -0
- package/build/ts/surfaces/admin/components/TextArea.d.ts +12 -0
- package/build/ts/surfaces/admin/components/TextField.d.ts +13 -0
- package/build/ts/surfaces/admin/components/Thumbnail.d.ts +9 -0
- package/build/ts/surfaces/admin/components/Tooltip.d.ts +11 -0
- package/build/ts/surfaces/admin/components/URLField.d.ts +12 -0
- package/build/ts/surfaces/admin/components/UnorderedList.d.ts +14 -0
- package/build/ts/surfaces/admin/components/shared.d.ts +267 -0
- package/build/ts/surfaces/admin/extension-targets.d.ts +8 -1
- package/build/ts/surfaces/admin/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/admin/targets/admin.app.intent.render.d.ts +61 -0
- package/build/ts/surfaces/checkout/api/address-autocomplete/format-suggestion.d.ts +2 -0
- package/build/ts/surfaces/checkout/api/address-autocomplete/format-suggestion.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/address-autocomplete/shared.d.ts +3 -0
- package/build/ts/surfaces/checkout/api/address-autocomplete/shared.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/address-autocomplete/standard.d.ts +2 -1
- package/build/ts/surfaces/checkout/api/address-autocomplete/standard.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/address-autocomplete/suggest.d.ts +2 -0
- package/build/ts/surfaces/checkout/api/address-autocomplete/suggest.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/announcement/announcement.d.ts +1 -0
- package/build/ts/surfaces/checkout/api/announcement/announcement.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts +5 -1
- package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts +258 -122
- package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/docs.d.ts +33 -6
- package/build/ts/surfaces/checkout/api/docs.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/order-confirmation/order-confirmation.d.ts +12 -5
- package/build/ts/surfaces/checkout/api/order-confirmation/order-confirmation.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/payment/payment-option-item.d.ts +7 -0
- package/build/ts/surfaces/checkout/api/payment/payment-option-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-item.d.ts +3 -2
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-list.d.ts +4 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-list.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-point-list.d.ts +4 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-point-list.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/redeemable/redeemable.d.ts +7 -0
- package/build/ts/surfaces/checkout/api/redeemable/redeemable.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/shared.d.ts +79 -31
- package/build/ts/surfaces/checkout/api/shared.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts +6 -4
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts +18 -12
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts +659 -425
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Abbreviation.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Announcement.d.ts +34 -9
- package/build/ts/surfaces/checkout/components/Badge.d.ts +44 -3
- package/build/ts/surfaces/checkout/components/Banner.d.ts +60 -9
- package/build/ts/surfaces/checkout/components/Box.d.ts +50 -0
- package/build/ts/surfaces/checkout/components/Button.d.ts +10 -3
- package/build/ts/surfaces/checkout/components/Chat.d.ts +20 -0
- package/build/ts/surfaces/checkout/components/Checkbox.d.ts +10 -2
- package/build/ts/surfaces/checkout/components/Chip.d.ts +3 -3
- package/build/ts/surfaces/checkout/components/Choice.d.ts +2 -0
- package/build/ts/surfaces/checkout/components/ChoiceList.d.ts +10 -2
- package/build/ts/surfaces/checkout/components/Clickable.d.ts +31 -7
- package/build/ts/surfaces/checkout/components/ClickableChip.d.ts +15 -8
- package/build/ts/surfaces/checkout/components/ClipboardItem.d.ts +10 -2
- package/build/ts/surfaces/checkout/components/ConsentCheckbox.d.ts +16 -2
- package/build/ts/surfaces/checkout/components/ConsentPhoneField.d.ts +24 -10
- package/build/ts/surfaces/checkout/components/DateField.d.ts +24 -6
- package/build/ts/surfaces/checkout/components/DatePicker.d.ts +21 -5
- package/build/ts/surfaces/checkout/components/Details.d.ts +13 -8
- package/build/ts/surfaces/checkout/components/Divider.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/DropZone.d.ts +15 -3
- package/build/ts/surfaces/checkout/components/EmailField.d.ts +18 -10
- package/build/ts/surfaces/checkout/components/Form.d.ts +9 -1
- package/build/ts/surfaces/checkout/components/Grid.d.ts +137 -0
- package/build/ts/surfaces/checkout/components/GridItem.d.ts +55 -0
- package/build/ts/surfaces/checkout/components/Heading.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Icon.d.ts +49 -4
- package/build/ts/surfaces/checkout/components/Image.d.ts +43 -1
- package/build/ts/surfaces/checkout/components/Link.d.ts +10 -3
- package/build/ts/surfaces/checkout/components/ListItem.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Map.d.ts +68 -6
- package/build/ts/surfaces/checkout/components/MapMarker.d.ts +36 -8
- package/build/ts/surfaces/checkout/components/Modal.d.ts +52 -8
- package/build/ts/surfaces/checkout/components/MoneyField.d.ts +16 -8
- package/build/ts/surfaces/checkout/components/NumberField.d.ts +18 -10
- package/build/ts/surfaces/checkout/components/Option.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/OrderedList.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Paragraph.d.ts +12 -0
- package/build/ts/surfaces/checkout/components/PasswordField.d.ts +18 -10
- package/build/ts/surfaces/checkout/components/PaymentIcon.d.ts +17 -1
- package/build/ts/surfaces/checkout/components/PhoneField.d.ts +18 -10
- package/build/ts/surfaces/checkout/components/Popover.d.ts +39 -22
- package/build/ts/surfaces/checkout/components/PressButton.d.ts +14 -6
- package/build/ts/surfaces/checkout/components/ProductThumbnail.d.ts +26 -1
- package/build/ts/surfaces/checkout/components/Progress.d.ts +27 -0
- package/build/ts/surfaces/checkout/components/QRCode.d.ts +28 -3
- package/build/ts/surfaces/checkout/components/QueryContainer.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/ScrollBox.d.ts +55 -0
- package/build/ts/surfaces/checkout/components/Section.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Select.d.ts +14 -6
- package/build/ts/surfaces/checkout/components/Sheet.d.ts +40 -13
- package/build/ts/surfaces/checkout/components/SkeletonParagraph.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Spinner.d.ts +16 -0
- package/build/ts/surfaces/checkout/components/Stack.d.ts +110 -0
- package/build/ts/surfaces/checkout/components/Summary.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Switch.d.ts +10 -2
- package/build/ts/surfaces/checkout/components/Text.d.ts +18 -1
- package/build/ts/surfaces/checkout/components/TextArea.d.ts +16 -8
- package/build/ts/surfaces/checkout/components/TextField.d.ts +18 -10
- package/build/ts/surfaces/checkout/components/Time.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Tooltip.d.ts +21 -2
- package/build/ts/surfaces/checkout/components/UnorderedList.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/UrlField.d.ts +18 -10
- package/build/ts/surfaces/checkout/components/components-shared.d.ts +728 -718
- package/build/ts/surfaces/checkout/components/components.d.ts +575 -297
- package/build/ts/surfaces/checkout/extension-targets.d.ts +13 -0
- package/build/ts/surfaces/checkout/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/globals.d.ts +1 -0
- package/build/ts/surfaces/checkout/globals.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/api.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/api.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/app-metafields.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/app-metafields.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/attributes.d.ts +3 -0
- package/build/ts/surfaces/checkout/preact/attributes.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/billing-address.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/billing-address.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/buyer-identity.d.ts +4 -0
- package/build/ts/surfaces/checkout/preact/buyer-identity.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/buyer-journey.d.ts +5 -0
- package/build/ts/surfaces/checkout/preact/buyer-journey.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/capabilities.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/capabilities.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/cart-line-target.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/cart-line-target.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/cart-lines.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/cart-lines.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/checkout-settings.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/checkout-settings.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/checkout-token.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/checkout-token.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/cost.d.ts +4 -0
- package/build/ts/surfaces/checkout/preact/cost.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/country.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/country.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/currency.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/currency.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/customer-privacy.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/customer-privacy.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/delivery-group-list-target.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/delivery-group-list-target.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/delivery-group-target.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/delivery-group-target.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/delivery-group.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/delivery-group.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/delivery-groups.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/delivery-groups.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/delivery-selection-groups.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/delivery-selection-groups.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/discounts.d.ts +3 -0
- package/build/ts/surfaces/checkout/preact/discounts.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/extension-editor.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/extension-editor.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/extension-language.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/extension-language.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/extension.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/extension.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/gift-cards.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/gift-cards.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/instructions.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/instructions.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/language.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/language.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/localized-fields.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/localized-fields.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/market.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/market.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/metafields.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/note.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/note.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/payment-method.d.ts +3 -0
- package/build/ts/surfaces/checkout/preact/payment-method.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/payment-options.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/payment-options.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/pickup-location-option-target.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/pickup-location-option-target.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/redeemable.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/redeemable.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/session-token.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/session-token.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/settings.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/settings.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/shipping-address.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/shipping-address.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/shipping-option-target.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/shipping-option-target.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/shop.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/shop.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/storage.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/storage.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/subscription.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/subscription.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/target.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/target.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/timezone.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/timezone.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/translate.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/translate.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/shared.d.ts +11 -19
- package/build/ts/surfaces/checkout/shared.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/style/style.d.ts +1 -0
- package/build/ts/surfaces/checkout/style/style.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/style/types.d.ts +20 -8
- package/build/ts/surfaces/checkout/style/types.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/targets/purchase.cart-line-item.line-components.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.actions.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.block.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-item.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.chat.render.d.ts +2 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.contact.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.footer.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.gift-card.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.header.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.action-required.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.details.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.hosted-fields.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-option-item.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.details.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.announcement.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.block.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-item.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.chat.render.d.ts +2 -1
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.customer-information.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.footer.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.header.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts +3 -0
- package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/docs.d.ts +239 -17
- package/build/ts/surfaces/customer-account/api/docs.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts +453 -296
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/shared.d.ts +209 -138
- package/build/ts/surfaces/customer-account/api/shared.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts +84 -68
- package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/Abbreviation.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Announcement.d.ts +34 -9
- package/build/ts/surfaces/customer-account/components/Avatar.d.ts +43 -15
- package/build/ts/surfaces/customer-account/components/Badge.d.ts +44 -3
- package/build/ts/surfaces/customer-account/components/Banner.d.ts +60 -9
- package/build/ts/surfaces/customer-account/components/Box.d.ts +50 -0
- package/build/ts/surfaces/customer-account/components/Button.d.ts +10 -3
- package/build/ts/surfaces/customer-account/components/ButtonGroup.d.ts +3 -3
- package/build/ts/surfaces/customer-account/components/Chat.d.ts +20 -0
- package/build/ts/surfaces/customer-account/components/Checkbox.d.ts +10 -2
- package/build/ts/surfaces/customer-account/components/Chip.d.ts +3 -3
- package/build/ts/surfaces/customer-account/components/Choice.d.ts +2 -0
- package/build/ts/surfaces/customer-account/components/ChoiceList.d.ts +10 -2
- package/build/ts/surfaces/customer-account/components/Clickable.d.ts +31 -7
- package/build/ts/surfaces/customer-account/components/ClickableChip.d.ts +15 -8
- package/build/ts/surfaces/customer-account/components/ClipboardItem.d.ts +10 -2
- package/build/ts/surfaces/customer-account/components/ConsentCheckbox.d.ts +16 -2
- package/build/ts/surfaces/customer-account/components/ConsentPhoneField.d.ts +24 -10
- package/build/ts/surfaces/customer-account/components/CustomerAccountAction.d.ts +3 -3
- package/build/ts/surfaces/customer-account/components/DateField.d.ts +24 -6
- package/build/ts/surfaces/customer-account/components/DatePicker.d.ts +21 -5
- package/build/ts/surfaces/customer-account/components/Details.d.ts +13 -8
- package/build/ts/surfaces/customer-account/components/Divider.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/DropZone.d.ts +15 -3
- package/build/ts/surfaces/customer-account/components/EmailField.d.ts +18 -10
- package/build/ts/surfaces/customer-account/components/Form.d.ts +9 -1
- package/build/ts/surfaces/customer-account/components/Grid.d.ts +137 -0
- package/build/ts/surfaces/customer-account/components/GridItem.d.ts +55 -0
- package/build/ts/surfaces/customer-account/components/Heading.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Icon.d.ts +49 -4
- package/build/ts/surfaces/customer-account/components/Image.d.ts +43 -1
- package/build/ts/surfaces/customer-account/components/ImageGroup.d.ts +7 -2
- package/build/ts/surfaces/customer-account/components/Link.d.ts +10 -3
- package/build/ts/surfaces/customer-account/components/ListItem.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Map.d.ts +68 -6
- package/build/ts/surfaces/customer-account/components/MapMarker.d.ts +36 -8
- package/build/ts/surfaces/customer-account/components/Menu.d.ts +1 -1
- package/build/ts/surfaces/customer-account/components/Modal.d.ts +52 -8
- package/build/ts/surfaces/customer-account/components/MoneyField.d.ts +16 -8
- package/build/ts/surfaces/customer-account/components/NumberField.d.ts +18 -10
- package/build/ts/surfaces/customer-account/components/Option.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/OrderedList.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Page.d.ts +5 -5
- package/build/ts/surfaces/customer-account/components/Paragraph.d.ts +12 -0
- package/build/ts/surfaces/customer-account/components/PasswordField.d.ts +18 -10
- package/build/ts/surfaces/customer-account/components/PaymentIcon.d.ts +17 -1
- package/build/ts/surfaces/customer-account/components/PhoneField.d.ts +18 -10
- package/build/ts/surfaces/customer-account/components/Popover.d.ts +39 -22
- package/build/ts/surfaces/customer-account/components/PressButton.d.ts +14 -6
- package/build/ts/surfaces/customer-account/components/ProductThumbnail.d.ts +26 -1
- package/build/ts/surfaces/customer-account/components/Progress.d.ts +27 -0
- package/build/ts/surfaces/customer-account/components/QRCode.d.ts +28 -3
- package/build/ts/surfaces/customer-account/components/QueryContainer.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/ScrollBox.d.ts +55 -0
- package/build/ts/surfaces/customer-account/components/Section.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Select.d.ts +14 -6
- package/build/ts/surfaces/customer-account/components/Sheet.d.ts +40 -13
- package/build/ts/surfaces/customer-account/components/SkeletonParagraph.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Spinner.d.ts +16 -0
- package/build/ts/surfaces/customer-account/components/Stack.d.ts +110 -0
- package/build/ts/surfaces/customer-account/components/Summary.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Switch.d.ts +10 -2
- package/build/ts/surfaces/customer-account/components/Text.d.ts +18 -1
- package/build/ts/surfaces/customer-account/components/TextArea.d.ts +16 -8
- package/build/ts/surfaces/customer-account/components/TextField.d.ts +18 -10
- package/build/ts/surfaces/customer-account/components/Time.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Tooltip.d.ts +21 -2
- package/build/ts/surfaces/customer-account/components/UnorderedList.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/UrlField.d.ts +18 -10
- package/build/ts/surfaces/customer-account/components/components-shared.d.ts +728 -718
- package/build/ts/surfaces/customer-account/components/components.d.ts +575 -297
- package/build/ts/surfaces/customer-account/components/shared.d.ts +23 -2
- package/build/ts/surfaces/customer-account/components/shared.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/shared.ts +23 -5
- package/build/ts/surfaces/customer-account/extension-targets.d.ts +8 -0
- package/build/ts/surfaces/customer-account/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.footer.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-index.announcement.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-index.block.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.announcement.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.block.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-item.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.customer-information.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.fulfillment-details.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.payment-details.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.return-details.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.unfulfilled-items.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order.action.menu-item.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order.action.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order.page.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.page.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.addresses.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.announcement.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.block.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-details.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-addresses.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-payment.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-staff.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.payment.render-after.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/action-target-api/action-target-api.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/api/action-target-api/action-target-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/camera-api/camera-api.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/api/camera-api/camera-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts +9 -0
- package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/device-api/device-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/device-api/device-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts +9 -0
- package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts +10 -0
- package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts +12 -1
- package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/Badge.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/Banner.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Box.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Button.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Choice.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Clickable.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/DateField.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/DatePicker.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/DateSpinner.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Divider.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/EmailField.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/components/Embed.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/EmptyState.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Heading.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/Icon.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Image.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/Link.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Modal.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/NumberField.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Page.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/PosBlock.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/QrCode.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/ScrollBox.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/SearchField.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Section.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Spinner.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Stack.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Switch.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Tab.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/TabList.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/TabPanel.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Tabs.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Text.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/TextArea.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/components/TextField.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Tile.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/TimeField.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/TimePicker.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +135 -0
- package/build/ts/surfaces/point-of-sale/components/targets/ActionExtensionComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/ActionExtensionComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/BasicComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/BasicComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/BlockExtensionComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/BlockExtensionComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/SmartGridComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/SmartGridComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts +3 -2
- package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +18 -0
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/cart.d.ts +13 -0
- package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/country-code.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/country-code.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/device.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/device.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/money.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/types/money.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/order.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/types/order.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/payment.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/types/payment.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/product.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/types/product.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/session.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/session.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/storage.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/src/shared.ts +32 -12
- package/src/surfaces/admin/api/action/action.ts +1 -0
- package/src/surfaces/admin/api/block/block.ts +2 -0
- package/src/surfaces/admin/api/checkout-rules/launch-options.ts +7 -3
- package/src/surfaces/admin/api/checkout-rules/metafields.ts +13 -6
- package/src/surfaces/admin/api/checkout-rules/validation-settings.ts +1 -0
- package/src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts +3 -0
- package/src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts +1 -0
- package/src/surfaces/admin/api/discount-function-settings/launch-options.ts +7 -2
- package/src/surfaces/admin/api/discount-function-settings/metafields.ts +13 -6
- package/src/surfaces/admin/api/generated/generated.ts +76 -0
- package/src/surfaces/admin/api/intents/intent-render.ts +26 -0
- package/src/surfaces/admin/api/intents/intents.ts +49 -8
- package/src/surfaces/admin/api/order-routing-rule/data.ts +5 -2
- package/src/surfaces/admin/api/order-routing-rule/metafields.ts +8 -3
- package/src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts +1 -0
- package/src/surfaces/admin/api/picker/picker.ts +15 -6
- package/src/surfaces/admin/api/print-action/print-action.ts +1 -0
- package/src/surfaces/admin/api/product-configuration/product-details-configuration.ts +4 -1
- package/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts +4 -1
- package/src/surfaces/admin/api/purchase-options-card-action.ts +1 -0
- package/src/surfaces/admin/api/resource-picker/resource-picker.ts +36 -17
- package/src/surfaces/admin/api/shared.ts +2 -0
- package/src/surfaces/admin/api/standard/standard-rendering.ts +3 -0
- package/src/surfaces/admin/api/standard/standard.ts +4 -1
- package/src/surfaces/admin/api/standard/storage.ts +4 -0
- package/src/surfaces/admin/api.ts +7 -0
- package/src/surfaces/admin/components/AdminAction.d.ts +6 -0
- package/src/surfaces/admin/components/AdminBlock.d.ts +6 -0
- package/src/surfaces/admin/components/AdminPrintAction.d.ts +6 -0
- package/src/surfaces/admin/components/Avatar.d.ts +9 -0
- package/src/surfaces/admin/components/Badge.d.ts +9 -0
- package/src/surfaces/admin/components/Banner.d.ts +11 -0
- package/src/surfaces/admin/components/Box.d.ts +14 -0
- package/src/surfaces/admin/components/Button.d.ts +14 -0
- package/src/surfaces/admin/components/ButtonGroup.d.ts +8 -0
- package/src/surfaces/admin/components/Checkbox.d.ts +12 -1
- package/src/surfaces/admin/components/Chip.d.ts +4 -2
- package/src/surfaces/admin/components/Choice.d.ts +10 -2
- package/src/surfaces/admin/components/ChoiceList.d.ts +12 -2
- package/src/surfaces/admin/components/Clickable.d.ts +16 -4
- package/src/surfaces/admin/components/ClickableChip.d.ts +11 -0
- package/src/surfaces/admin/components/ColorField.d.ts +12 -0
- package/src/surfaces/admin/components/ColorPicker.d.ts +9 -0
- package/src/surfaces/admin/components/DateField.d.ts +11 -0
- package/src/surfaces/admin/components/DatePicker.d.ts +10 -1
- package/src/surfaces/admin/components/Divider.d.ts +7 -0
- package/src/surfaces/admin/components/DropZone.d.ts +8 -4
- package/src/surfaces/admin/components/EmailField.d.ts +12 -0
- package/src/surfaces/admin/components/Form.d.ts +10 -0
- package/src/surfaces/admin/components/FunctionSettings.d.ts +12 -0
- package/src/surfaces/admin/components/Grid.d.ts +16 -0
- package/src/surfaces/admin/components/GridItem.d.ts +15 -0
- package/src/surfaces/admin/components/Heading.d.ts +8 -0
- package/src/surfaces/admin/components/Icon.d.ts +6 -3
- package/src/surfaces/admin/components/Image.d.ts +15 -0
- package/src/surfaces/admin/components/Link.d.ts +13 -3
- package/src/surfaces/admin/components/ListItem.d.ts +8 -0
- package/src/surfaces/admin/components/Menu.d.ts +11 -0
- package/src/surfaces/admin/components/Modal.d.ts +8 -4
- package/src/surfaces/admin/components/MoneyField.d.ts +13 -0
- package/src/surfaces/admin/components/NumberField.d.ts +12 -0
- package/src/surfaces/admin/components/Option.d.ts +10 -2
- package/src/surfaces/admin/components/OptionGroup.d.ts +10 -2
- package/src/surfaces/admin/components/OrderedList.d.ts +8 -0
- package/src/surfaces/admin/components/Page.d.ts +4 -2
- package/src/surfaces/admin/components/Paragraph.d.ts +8 -0
- package/src/surfaces/admin/components/PasswordField.d.ts +12 -0
- package/src/surfaces/admin/components/QueryContainer.d.ts +8 -0
- package/src/surfaces/admin/components/SearchField.d.ts +13 -1
- package/src/surfaces/admin/components/Section.d.ts +9 -0
- package/src/surfaces/admin/components/Select.d.ts +14 -2
- package/src/surfaces/admin/components/Spinner.d.ts +7 -0
- package/src/surfaces/admin/components/Stack.d.ts +16 -0
- package/src/surfaces/admin/components/Switch.d.ts +12 -1
- package/src/surfaces/admin/components/Table.d.ts +15 -0
- package/src/surfaces/admin/components/TableBody.d.ts +8 -0
- package/src/surfaces/admin/components/TableCell.d.ts +9 -0
- package/src/surfaces/admin/components/TableHeader.d.ts +9 -0
- package/src/surfaces/admin/components/TableHeaderRow.d.ts +8 -0
- package/src/surfaces/admin/components/TableRow.d.ts +8 -0
- package/src/surfaces/admin/components/Text.d.ts +19 -0
- package/src/surfaces/admin/components/TextArea.d.ts +12 -0
- package/src/surfaces/admin/components/TextField.d.ts +13 -0
- package/src/surfaces/admin/components/Thumbnail.d.ts +9 -0
- package/src/surfaces/admin/components/Tooltip.d.ts +11 -0
- package/src/surfaces/admin/components/URLField.d.ts +12 -0
- package/src/surfaces/admin/components/UnorderedList.d.ts +14 -0
- package/src/surfaces/admin/components/shared.d.ts +267 -0
- package/src/surfaces/admin/components.d.ts +700 -0
- package/src/surfaces/admin/extension-targets.ts +12 -0
- package/src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts +2 -0
- package/src/surfaces/checkout/api/address-autocomplete/shared.ts +3 -0
- package/src/surfaces/checkout/api/address-autocomplete/standard.ts +2 -1
- package/src/surfaces/checkout/api/address-autocomplete/suggest.ts +2 -0
- package/src/surfaces/checkout/api/announcement/announcement.ts +1 -0
- package/src/surfaces/checkout/api/cart-line/cart-line-item.ts +5 -1
- package/src/surfaces/checkout/api/checkout/checkout.ts +258 -122
- package/src/surfaces/checkout/api/docs.ts +34 -1
- package/src/surfaces/checkout/api/order-confirmation/order-confirmation.ts +12 -5
- package/src/surfaces/checkout/api/payment/payment-option-item.ts +7 -0
- package/src/surfaces/checkout/api/pickup/pickup-location-item.ts +3 -2
- package/src/surfaces/checkout/api/pickup/pickup-location-list.ts +4 -1
- package/src/surfaces/checkout/api/pickup/pickup-point-list.ts +4 -1
- package/src/surfaces/checkout/api/redeemable/redeemable.ts +7 -0
- package/src/surfaces/checkout/api/shared.ts +79 -31
- package/src/surfaces/checkout/api/shipping/shipping-option-item.ts +6 -4
- package/src/surfaces/checkout/api/shipping/shipping-option-list.ts +18 -12
- package/src/surfaces/checkout/api/standard/standard.ts +661 -425
- package/src/surfaces/checkout/components/Abbreviation.d.ts +1 -0
- package/src/surfaces/checkout/components/Announcement.d.ts +34 -9
- package/src/surfaces/checkout/components/Badge.d.ts +44 -3
- package/src/surfaces/checkout/components/Banner.d.ts +60 -9
- package/src/surfaces/checkout/components/Box.d.ts +50 -0
- package/src/surfaces/checkout/components/Button.d.ts +10 -3
- package/src/surfaces/checkout/components/Chat.d.ts +20 -0
- package/src/surfaces/checkout/components/Checkbox.d.ts +10 -2
- package/src/surfaces/checkout/components/Chip.d.ts +3 -3
- package/src/surfaces/checkout/components/Choice.d.ts +2 -0
- package/src/surfaces/checkout/components/ChoiceList.d.ts +10 -2
- package/src/surfaces/checkout/components/Clickable.d.ts +31 -7
- package/src/surfaces/checkout/components/ClickableChip.d.ts +15 -8
- package/src/surfaces/checkout/components/ClipboardItem.d.ts +10 -2
- package/src/surfaces/checkout/components/ConsentCheckbox.d.ts +16 -2
- package/src/surfaces/checkout/components/ConsentPhoneField.d.ts +24 -10
- package/src/surfaces/checkout/components/DateField.d.ts +24 -6
- package/src/surfaces/checkout/components/DatePicker.d.ts +21 -5
- package/src/surfaces/checkout/components/Details.d.ts +13 -8
- package/src/surfaces/checkout/components/Divider.d.ts +1 -0
- package/src/surfaces/checkout/components/DropZone.d.ts +15 -3
- package/src/surfaces/checkout/components/EmailField.d.ts +18 -10
- package/src/surfaces/checkout/components/Form.d.ts +9 -1
- package/src/surfaces/checkout/components/Grid.d.ts +137 -0
- package/src/surfaces/checkout/components/GridItem.d.ts +55 -0
- package/src/surfaces/checkout/components/Heading.d.ts +1 -0
- package/src/surfaces/checkout/components/Icon.d.ts +49 -4
- package/src/surfaces/checkout/components/Image.d.ts +43 -1
- package/src/surfaces/checkout/components/Link.d.ts +10 -3
- package/src/surfaces/checkout/components/ListItem.d.ts +1 -0
- package/src/surfaces/checkout/components/Map.d.ts +68 -6
- package/src/surfaces/checkout/components/MapMarker.d.ts +36 -8
- package/src/surfaces/checkout/components/Modal.d.ts +52 -8
- package/src/surfaces/checkout/components/MoneyField.d.ts +16 -8
- package/src/surfaces/checkout/components/NumberField.d.ts +18 -10
- package/src/surfaces/checkout/components/Option.d.ts +1 -0
- package/src/surfaces/checkout/components/OrderedList.d.ts +1 -0
- package/src/surfaces/checkout/components/Paragraph.d.ts +12 -0
- package/src/surfaces/checkout/components/PasswordField.d.ts +18 -10
- package/src/surfaces/checkout/components/PaymentIcon.d.ts +17 -1
- package/src/surfaces/checkout/components/PhoneField.d.ts +18 -10
- package/src/surfaces/checkout/components/Popover.d.ts +39 -22
- package/src/surfaces/checkout/components/PressButton.d.ts +14 -6
- package/src/surfaces/checkout/components/ProductThumbnail.d.ts +26 -1
- package/src/surfaces/checkout/components/Progress.d.ts +27 -0
- package/src/surfaces/checkout/components/QRCode.d.ts +28 -3
- package/src/surfaces/checkout/components/QueryContainer.d.ts +1 -0
- package/src/surfaces/checkout/components/ScrollBox.d.ts +55 -0
- package/src/surfaces/checkout/components/Section.d.ts +4 -0
- package/src/surfaces/checkout/components/Select.d.ts +14 -6
- package/src/surfaces/checkout/components/Sheet.d.ts +40 -13
- package/src/surfaces/checkout/components/SkeletonParagraph.d.ts +1 -0
- package/src/surfaces/checkout/components/Spinner.d.ts +16 -0
- package/src/surfaces/checkout/components/Stack.d.ts +110 -0
- package/src/surfaces/checkout/components/Summary.d.ts +1 -0
- package/src/surfaces/checkout/components/Switch.d.ts +10 -2
- package/src/surfaces/checkout/components/Text.d.ts +18 -1
- package/src/surfaces/checkout/components/TextArea.d.ts +16 -8
- package/src/surfaces/checkout/components/TextField.d.ts +18 -10
- package/src/surfaces/checkout/components/Time.d.ts +1 -0
- package/src/surfaces/checkout/components/Tooltip.d.ts +21 -2
- package/src/surfaces/checkout/components/UnorderedList.d.ts +1 -0
- package/src/surfaces/checkout/components/UrlField.d.ts +18 -10
- package/src/surfaces/checkout/components/components-shared.d.ts +728 -718
- package/src/surfaces/checkout/components/components.d.ts +575 -297
- package/src/surfaces/checkout/extension-targets.ts +13 -0
- package/src/surfaces/checkout/globals.ts +1 -0
- package/src/surfaces/checkout/preact/api.ts +2 -0
- package/src/surfaces/checkout/preact/app-metafields.ts +1 -0
- package/src/surfaces/checkout/preact/attributes.ts +3 -0
- package/src/surfaces/checkout/preact/billing-address.ts +1 -0
- package/src/surfaces/checkout/preact/buyer-identity.ts +4 -0
- package/src/surfaces/checkout/preact/buyer-journey.ts +5 -0
- package/src/surfaces/checkout/preact/capabilities.ts +2 -0
- package/src/surfaces/checkout/preact/cart-line-target.ts +1 -0
- package/src/surfaces/checkout/preact/cart-lines.ts +2 -0
- package/src/surfaces/checkout/preact/checkout-settings.ts +1 -0
- package/src/surfaces/checkout/preact/checkout-token.ts +1 -0
- package/src/surfaces/checkout/preact/cost.ts +4 -0
- package/src/surfaces/checkout/preact/country.ts +1 -0
- package/src/surfaces/checkout/preact/currency.ts +1 -0
- package/src/surfaces/checkout/preact/customer-privacy.ts +1 -0
- package/src/surfaces/checkout/preact/delivery-group-list-target.ts +1 -0
- package/src/surfaces/checkout/preact/delivery-group-target.ts +1 -0
- package/src/surfaces/checkout/preact/delivery-group.ts +1 -0
- package/src/surfaces/checkout/preact/delivery-groups.ts +1 -0
- package/src/surfaces/checkout/preact/delivery-selection-groups.ts +1 -0
- package/src/surfaces/checkout/preact/discounts.ts +3 -0
- package/src/surfaces/checkout/preact/extension-editor.ts +1 -0
- package/src/surfaces/checkout/preact/extension-language.ts +1 -0
- package/src/surfaces/checkout/preact/extension.ts +2 -0
- package/src/surfaces/checkout/preact/gift-cards.ts +2 -0
- package/src/surfaces/checkout/preact/instructions.ts +1 -0
- package/src/surfaces/checkout/preact/language.ts +1 -0
- package/src/surfaces/checkout/preact/localized-fields.ts +2 -0
- package/src/surfaces/checkout/preact/market.ts +1 -0
- package/src/surfaces/checkout/preact/metafields.ts +1 -0
- package/src/surfaces/checkout/preact/note.ts +2 -0
- package/src/surfaces/checkout/preact/payment-method.ts +3 -0
- package/src/surfaces/checkout/preact/payment-options.ts +2 -0
- package/src/surfaces/checkout/preact/pickup-location-option-target.ts +1 -0
- package/src/surfaces/checkout/preact/redeemable.ts +1 -0
- package/src/surfaces/checkout/preact/session-token.ts +1 -0
- package/src/surfaces/checkout/preact/settings.ts +1 -0
- package/src/surfaces/checkout/preact/shipping-address.ts +2 -0
- package/src/surfaces/checkout/preact/shipping-option-target.ts +1 -0
- package/src/surfaces/checkout/preact/shop.ts +1 -0
- package/src/surfaces/checkout/preact/storage.ts +1 -0
- package/src/surfaces/checkout/preact/subscription.ts +1 -0
- package/src/surfaces/checkout/preact/target.ts +1 -0
- package/src/surfaces/checkout/preact/timezone.ts +1 -0
- package/src/surfaces/checkout/preact/translate.ts +1 -0
- package/src/surfaces/checkout/shared.ts +11 -21
- package/src/surfaces/checkout/style/style.ts +1 -0
- package/src/surfaces/checkout/style/types.ts +20 -7
- package/src/surfaces/customer-account/api/cart-line/cart-line-item.ts +3 -0
- package/src/surfaces/customer-account/api/docs.ts +244 -19
- package/src/surfaces/customer-account/api/order-status/order-status.ts +460 -296
- package/src/surfaces/customer-account/api/shared.ts +210 -138
- package/src/surfaces/customer-account/api/standard-api/standard-api.ts +84 -68
- package/src/surfaces/customer-account/components/Avatar.d.ts +43 -15
- package/src/surfaces/customer-account/components/ButtonGroup.d.ts +3 -3
- package/src/surfaces/customer-account/components/CustomerAccountAction.d.ts +3 -3
- package/src/surfaces/customer-account/components/ImageGroup.d.ts +7 -2
- package/src/surfaces/customer-account/components/Menu.d.ts +1 -1
- package/src/surfaces/customer-account/components/Page.d.ts +5 -5
- package/src/surfaces/customer-account/components/Section.d.ts +3 -7
- package/src/surfaces/customer-account/components/shared.ts +23 -5
- package/src/surfaces/customer-account/components.d.ts +93 -0
- package/src/surfaces/customer-account/extension-targets.ts +8 -0
- package/src/surfaces/point-of-sale/api/action-api/action-api.ts +4 -0
- package/src/surfaces/point-of-sale/api/action-target-api/action-target-api.ts +3 -0
- package/src/surfaces/point-of-sale/api/camera-api/camera-api.ts +4 -0
- package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +7 -0
- package/src/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.ts +1 -0
- package/src/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.ts +2 -0
- package/src/surfaces/point-of-sale/api/connectivity-api/connectivity-api.ts +9 -0
- package/src/surfaces/point-of-sale/api/customer-api/customer-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/device-api/device-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/draft-order-api/draft-order-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/locale-api/locale-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts +9 -0
- package/src/surfaces/point-of-sale/api/order-api/order-api.ts +2 -0
- package/src/surfaces/point-of-sale/api/pin-pad-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/print-api/print-api.ts +2 -0
- package/src/surfaces/point-of-sale/api/product-api/product-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/product-search-api/product-search-api.ts +10 -0
- package/src/surfaces/point-of-sale/api/scanner-api/scanner-api.ts +12 -1
- package/src/surfaces/point-of-sale/api/session-api/session-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/standard/standard-api.ts +3 -0
- package/src/surfaces/point-of-sale/api/storage-api/storage-api.ts +1 -0
- package/src/surfaces/point-of-sale/api/toast-api/toast-api.ts +5 -0
- package/src/surfaces/point-of-sale/components/Badge.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/Banner.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Box.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Button.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Choice.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/ChoiceList.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Clickable.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/DateField.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/DatePicker.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/DateSpinner.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Divider.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/EmailField.d.ts +8 -0
- package/src/surfaces/point-of-sale/components/Embed.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/EmptyState.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Heading.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/Icon.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Image.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/Link.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Modal.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/NumberField.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Page.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/PosBlock.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/QrCode.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/ScrollBox.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/SearchField.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Section.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Spinner.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Stack.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Switch.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Tab.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/TabList.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/TabPanel.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Tabs.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Text.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/TextArea.d.ts +8 -0
- package/src/surfaces/point-of-sale/components/TextField.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Tile.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/TimeField.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/TimePicker.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/components-shared.d.ts +135 -0
- package/src/surfaces/point-of-sale/components/targets/ActionExtensionComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components/targets/BasicComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components/targets/BlockExtensionComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components/targets/ReceiptComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components/targets/SmartGridComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components/targets/StandardComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components.d.ts +286 -0
- package/src/surfaces/point-of-sale/event/data/BaseApi.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/BaseData.ts +7 -2
- package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +2 -0
- package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +2 -0
- package/src/surfaces/point-of-sale/event/output/BaseOutput.ts +1 -0
- package/src/surfaces/point-of-sale/extension-targets.ts +18 -0
- package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +1 -0
- package/src/surfaces/point-of-sale/types/cart.ts +13 -0
- package/src/surfaces/point-of-sale/types/country-code.ts +1 -0
- package/src/surfaces/point-of-sale/types/device.ts +1 -0
- package/src/surfaces/point-of-sale/types/direct-api-request-body.ts +1 -0
- package/src/surfaces/point-of-sale/types/discount-allocation.ts +1 -0
- package/src/surfaces/point-of-sale/types/money.ts +2 -0
- package/src/surfaces/point-of-sale/types/multiple-resource-result.ts +1 -0
- package/src/surfaces/point-of-sale/types/order.ts +2 -0
- package/src/surfaces/point-of-sale/types/paginated-result.ts +1 -0
- package/src/surfaces/point-of-sale/types/payment.ts +2 -0
- package/src/surfaces/point-of-sale/types/pin-pad.ts +5 -0
- package/src/surfaces/point-of-sale/types/product.ts +5 -0
- package/src/surfaces/point-of-sale/types/session.ts +1 -0
- package/src/surfaces/point-of-sale/types/shipping-line.ts +3 -0
- package/src/surfaces/point-of-sale/types/storage.ts +4 -0
- package/src/surfaces/point-of-sale/types/tax-line.ts +1 -0
- package/src/surfaces/point-of-sale/types/transaction-type.ts +1 -0
|
@@ -13,10 +13,12 @@
|
|
|
13
13
|
/**
|
|
14
14
|
* Represents any valid children that can be rendered within a component, including elements, strings, numbers, or arrays of these types.
|
|
15
15
|
* This is an alias for Preact's `ComponentChildren` type.
|
|
16
|
+
* @publicDocs
|
|
16
17
|
*/
|
|
17
18
|
export type ComponentChildren = preact.ComponentChildren;
|
|
18
19
|
/**
|
|
19
20
|
* Represents string-only children for components that specifically require text content.
|
|
21
|
+
* @publicDocs
|
|
20
22
|
*/
|
|
21
23
|
export type StringChildren = string;
|
|
22
24
|
export interface GlobalProps {
|
|
@@ -26,12 +28,17 @@ export interface GlobalProps {
|
|
|
26
28
|
*/
|
|
27
29
|
id?: string;
|
|
28
30
|
}
|
|
31
|
+
/** @publicDocs */
|
|
29
32
|
export interface ActionProps {
|
|
30
33
|
/**
|
|
31
34
|
* The text to use as the action modal's title. If not provided, the name of the extension will be used.
|
|
32
35
|
*/
|
|
33
36
|
heading?: string;
|
|
34
37
|
}
|
|
38
|
+
/**
|
|
39
|
+
* The action component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
40
|
+
* @publicDocs
|
|
41
|
+
*/
|
|
35
42
|
export interface ActionSlots {
|
|
36
43
|
/**
|
|
37
44
|
* The primary action button or link, representing the main or most important action available in this context.
|
|
@@ -70,6 +77,7 @@ interface AdminPrintActionProps$1 extends GlobalProps {
|
|
|
70
77
|
*/
|
|
71
78
|
src?: string;
|
|
72
79
|
}
|
|
80
|
+
/** @publicDocs */
|
|
73
81
|
export interface BaseOverlayProps {
|
|
74
82
|
/**
|
|
75
83
|
* A callback fired immediately after the overlay is shown.
|
|
@@ -94,6 +102,7 @@ export interface BaseOverlayProps {
|
|
|
94
102
|
* All methods are required (not optional) because components implementing this interface must provide
|
|
95
103
|
* consistent JavaScript APIs. Unlike props/attributes, methods are not rendered in HTML and consumers
|
|
96
104
|
* expect them to be available on all component instances.
|
|
105
|
+
* @publicDocs
|
|
97
106
|
*/
|
|
98
107
|
export interface BaseOverlayMethods {
|
|
99
108
|
/**
|
|
@@ -115,6 +124,7 @@ export interface BaseOverlayMethods {
|
|
|
115
124
|
*/
|
|
116
125
|
toggleOverlay: () => void;
|
|
117
126
|
}
|
|
127
|
+
/** @publicDocs */
|
|
118
128
|
export interface FocusEventProps {
|
|
119
129
|
/**
|
|
120
130
|
* A callback fired when the component loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).
|
|
@@ -125,6 +135,7 @@ export interface FocusEventProps {
|
|
|
125
135
|
*/
|
|
126
136
|
onFocus?: (event: FocusEvent) => void;
|
|
127
137
|
}
|
|
138
|
+
/** @publicDocs */
|
|
128
139
|
export interface ToggleEventProps {
|
|
129
140
|
/**
|
|
130
141
|
* A callback fired when the element state changes, after any toggle animations have finished.
|
|
@@ -154,6 +165,7 @@ export interface ToggleEventProps {
|
|
|
154
165
|
*
|
|
155
166
|
* - `open`: The element is visible or expanded.
|
|
156
167
|
* - `closed`: The element is hidden or collapsed.
|
|
168
|
+
* @publicDocs
|
|
157
169
|
*/
|
|
158
170
|
export type ToggleState = 'open' | 'closed';
|
|
159
171
|
interface ToggleEvent$1 extends Event {
|
|
@@ -166,6 +178,7 @@ interface ToggleEvent$1 extends Event {
|
|
|
166
178
|
*/
|
|
167
179
|
readonly oldState: ToggleState;
|
|
168
180
|
}
|
|
181
|
+
/** @publicDocs */
|
|
169
182
|
export interface ExtendableEvent extends Event {
|
|
170
183
|
/**
|
|
171
184
|
* A method that accepts a promise signaling the duration and eventual success or failure of event-related actions.
|
|
@@ -175,6 +188,7 @@ export interface ExtendableEvent extends Event {
|
|
|
175
188
|
*/
|
|
176
189
|
waitUntil?: (promise: Promise<void>) => void;
|
|
177
190
|
}
|
|
191
|
+
/** @publicDocs */
|
|
178
192
|
export interface AggregateError<T extends Error> extends Error {
|
|
179
193
|
/**
|
|
180
194
|
* An array of individual errors that have been aggregated together.
|
|
@@ -182,6 +196,7 @@ export interface AggregateError<T extends Error> extends Error {
|
|
|
182
196
|
*/
|
|
183
197
|
errors: T[];
|
|
184
198
|
}
|
|
199
|
+
/** @publicDocs */
|
|
185
200
|
export interface AggregateErrorEvent<T extends Error> extends ErrorEvent {
|
|
186
201
|
/**
|
|
187
202
|
* The aggregated error object containing multiple individual errors.
|
|
@@ -200,6 +215,7 @@ export interface AggregateErrorEvent<T extends Error> extends ErrorEvent {
|
|
|
200
215
|
*
|
|
201
216
|
*
|
|
202
217
|
* @default 'base'
|
|
218
|
+
* @publicDocs
|
|
203
219
|
*/
|
|
204
220
|
export type SizeKeyword =
|
|
205
221
|
| 'small-500'
|
|
@@ -222,6 +238,7 @@ export type SizeKeyword =
|
|
|
222
238
|
* - `base`: Primary color for body text, standard UI elements, and general content with good readability.
|
|
223
239
|
* - `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.
|
|
224
240
|
*
|
|
241
|
+
* @publicDocs
|
|
225
242
|
*/
|
|
226
243
|
export type ColorKeyword = 'subdued' | 'base' | 'strong';
|
|
227
244
|
interface AvatarProps$1 extends GlobalProps {
|
|
@@ -271,6 +288,7 @@ interface AvatarProps$1 extends GlobalProps {
|
|
|
271
288
|
* - `transparent`: No background, allowing the underlying surface to show through.
|
|
272
289
|
* - `ColorKeyword`: Applies color intensity levels (subdued, base, strong) to create spatial emphasis and containment.
|
|
273
290
|
*
|
|
291
|
+
* @publicDocs
|
|
274
292
|
*/
|
|
275
293
|
export type BackgroundColorKeyword = 'transparent' | ColorKeyword;
|
|
276
294
|
export interface BackgroundProps {
|
|
@@ -301,6 +319,7 @@ export interface BackgroundProps {
|
|
|
301
319
|
* - `custom`: Custom color treatment defined by your theme or implementation.
|
|
302
320
|
*
|
|
303
321
|
* @default 'auto'
|
|
322
|
+
* @publicDocs
|
|
304
323
|
*/
|
|
305
324
|
export type ToneKeyword =
|
|
306
325
|
| 'auto'
|
|
@@ -875,6 +894,7 @@ declare const privateIconArray: readonly [
|
|
|
875
894
|
/**
|
|
876
895
|
* Represents the available icon names that can be used in icon components.
|
|
877
896
|
* This is derived from the complete list of supported icons in the design system.
|
|
897
|
+
* @publicDocs
|
|
878
898
|
*/
|
|
879
899
|
export type IconType = (typeof privateIconArray)[number];
|
|
880
900
|
/**
|
|
@@ -882,6 +902,7 @@ export type IconType = (typeof privateIconArray)[number];
|
|
|
882
902
|
* to be assignable to the first. This provides compile-time validation that you're only extracting
|
|
883
903
|
* types that actually exist within the union, catching potential errors earlier in development.
|
|
884
904
|
*
|
|
905
|
+
* @publicDocs
|
|
885
906
|
*/
|
|
886
907
|
export type ExtractStrict<T, U extends T> = Extract<T, U>;
|
|
887
908
|
/**
|
|
@@ -892,6 +913,7 @@ export type ExtractStrict<T, U extends T> = Extract<T, U>;
|
|
|
892
913
|
* - `${T} ${T}`: Two values for block axis (top/bottom) and inline axis (left/right).
|
|
893
914
|
* - `${T} ${T} ${T}`: Three values for block-start (top), inline axis (left/right), and block-end (bottom).
|
|
894
915
|
* - `${T} ${T} ${T} ${T}`: Four values for block-start (top), inline-end (right), block-end (bottom), and inline-start (left).
|
|
916
|
+
* @publicDocs
|
|
895
917
|
*/
|
|
896
918
|
export type MaybeAllValuesShorthandProperty<T extends string> =
|
|
897
919
|
| T
|
|
@@ -904,6 +926,7 @@ export type MaybeAllValuesShorthandProperty<T extends string> =
|
|
|
904
926
|
*
|
|
905
927
|
* - `T`: Single value that applies to both dimensions.
|
|
906
928
|
* - `${T} ${T}`: Two values for block axis (vertical) and inline axis (horizontal).
|
|
929
|
+
* @publicDocs
|
|
907
930
|
*/
|
|
908
931
|
export type MaybeTwoValuesShorthandProperty<T extends string> = T | `${T} ${T}`;
|
|
909
932
|
/**
|
|
@@ -912,6 +935,7 @@ export type MaybeTwoValuesShorthandProperty<T extends string> = T | `${T} ${T}`;
|
|
|
912
935
|
*
|
|
913
936
|
* - `T`: Base value that applies in all conditions.
|
|
914
937
|
* - `@container${string}`: Container query string for conditional responsive styling based on container size.
|
|
938
|
+
* @publicDocs
|
|
915
939
|
*/
|
|
916
940
|
export type MaybeResponsive<T> = T | `@container${string}`;
|
|
917
941
|
/**
|
|
@@ -919,12 +943,14 @@ export type MaybeResponsive<T> = T | `@container${string}`;
|
|
|
919
943
|
* By intersecting `string` with an empty object type, this prevents TypeScript from widening literal types,
|
|
920
944
|
* preserving IDE suggestions for known values while maintaining flexibility for custom strings.
|
|
921
945
|
*
|
|
946
|
+
* @publicDocs
|
|
922
947
|
*/
|
|
923
948
|
export type AnyString = string & {};
|
|
924
949
|
/**
|
|
925
950
|
* A utility type representing an optional space character for use in string literal type composition.
|
|
926
951
|
* Allows flexible formatting of compound values where spacing is a matter of preference rather than semantic difference.
|
|
927
952
|
*
|
|
953
|
+
* @publicDocs
|
|
928
954
|
*/
|
|
929
955
|
export type optionalSpace = '' | ' ';
|
|
930
956
|
interface BadgeProps$1 extends GlobalProps {
|
|
@@ -1046,6 +1072,7 @@ interface BannerProps$1 extends GlobalProps, ActionSlots {
|
|
|
1046
1072
|
*/
|
|
1047
1073
|
hidden?: boolean;
|
|
1048
1074
|
}
|
|
1075
|
+
/** @publicDocs */
|
|
1049
1076
|
export interface DisplayProps {
|
|
1050
1077
|
/**
|
|
1051
1078
|
* 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).
|
|
@@ -1059,6 +1086,7 @@ export interface DisplayProps {
|
|
|
1059
1086
|
*/
|
|
1060
1087
|
display?: MaybeResponsive<'auto' | 'none'>;
|
|
1061
1088
|
}
|
|
1089
|
+
/** @publicDocs */
|
|
1062
1090
|
export interface AccessibilityRoleProps {
|
|
1063
1091
|
/**
|
|
1064
1092
|
* The semantic meaning of the component’s content. When set,
|
|
@@ -1101,6 +1129,7 @@ export interface AccessibilityRoleProps {
|
|
|
1101
1129
|
* - `generic`: Creates a semantically neutral container element with no inherent meaning.
|
|
1102
1130
|
* - `presentation`: Removes semantic meaning from an element while preserving its visual appearance.
|
|
1103
1131
|
* - `none`: Synonym for `presentation`, removes semantic meaning while keeping visual styling.
|
|
1132
|
+
* @publicDocs
|
|
1104
1133
|
*/
|
|
1105
1134
|
export type AccessibilityRole =
|
|
1106
1135
|
/**
|
|
@@ -1230,6 +1259,7 @@ export interface AccessibilityVisibilityProps {
|
|
|
1230
1259
|
*/
|
|
1231
1260
|
accessibilityVisibility?: 'visible' | 'hidden' | 'exclusive';
|
|
1232
1261
|
}
|
|
1262
|
+
/** @publicDocs */
|
|
1233
1263
|
export interface LabelAccessibilityVisibilityProps {
|
|
1234
1264
|
/**
|
|
1235
1265
|
* Controls whether the label is visible to all users or only to screen readers.
|
|
@@ -1252,6 +1282,7 @@ export interface LabelAccessibilityVisibilityProps {
|
|
|
1252
1282
|
*
|
|
1253
1283
|
* - `SizeKeyword`: Standard padding sizes from the size scale for consistent spacing.
|
|
1254
1284
|
* - `none`: No padding.
|
|
1285
|
+
* @publicDocs
|
|
1255
1286
|
*/
|
|
1256
1287
|
export type PaddingKeyword = SizeKeyword | 'none';
|
|
1257
1288
|
export interface PaddingProps {
|
|
@@ -1338,6 +1369,7 @@ export interface PaddingProps {
|
|
|
1338
1369
|
* - `${number}px`: Absolute size in pixels for fixed dimensions (such as `100px`, `24px`).
|
|
1339
1370
|
* - `${number}%`: Relative size as a percentage of the parent container (such as `50%`, `100%`).
|
|
1340
1371
|
* - `0`: Zero size, equivalent to no dimension.
|
|
1372
|
+
* @publicDocs
|
|
1341
1373
|
*/
|
|
1342
1374
|
export type SizeUnits = `${number}px` | `${number}%` | `0`;
|
|
1343
1375
|
/**
|
|
@@ -1345,6 +1377,7 @@ export type SizeUnits = `${number}px` | `${number}%` | `0`;
|
|
|
1345
1377
|
*
|
|
1346
1378
|
* - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
|
|
1347
1379
|
* - `auto`: Automatically sizes based on content and layout constraints.
|
|
1380
|
+
* @publicDocs
|
|
1348
1381
|
*/
|
|
1349
1382
|
export type SizeUnitsOrAuto = SizeUnits | 'auto';
|
|
1350
1383
|
/**
|
|
@@ -1352,6 +1385,7 @@ export type SizeUnitsOrAuto = SizeUnits | 'auto';
|
|
|
1352
1385
|
*
|
|
1353
1386
|
* - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
|
|
1354
1387
|
* - `none`: No size constraint, allowing unlimited growth.
|
|
1388
|
+
* @publicDocs
|
|
1355
1389
|
*/
|
|
1356
1390
|
export type SizeUnitsOrNone = SizeUnits | 'none';
|
|
1357
1391
|
export interface SizingProps {
|
|
@@ -1432,6 +1466,7 @@ export interface SizingProps {
|
|
|
1432
1466
|
* - `dashed`: A series of short dashes.
|
|
1433
1467
|
* - `dotted`: A series of dots.
|
|
1434
1468
|
* - `auto`: Automatically determined based on context.
|
|
1469
|
+
* @publicDocs
|
|
1435
1470
|
*/
|
|
1436
1471
|
export type BorderStyleKeyword =
|
|
1437
1472
|
| 'none'
|
|
@@ -1444,14 +1479,17 @@ export type BorderStyleKeyword =
|
|
|
1444
1479
|
*
|
|
1445
1480
|
* - `SizeKeyword`: Standard border widths from the size scale for consistent thickness.
|
|
1446
1481
|
* - `none`: No border width (removes the border).
|
|
1482
|
+
* @publicDocs
|
|
1447
1483
|
*/
|
|
1448
1484
|
export type BorderSizeKeyword = SizeKeyword | 'none';
|
|
1449
1485
|
/**
|
|
1450
1486
|
* Defines the radius of rounded corners, using the standard size scale, `max` for fully rounded, or `none` for sharp corners.
|
|
1487
|
+
* @publicDocs
|
|
1451
1488
|
*/
|
|
1452
1489
|
export type BorderRadiusKeyword = SizeKeyword | 'max' | 'none';
|
|
1453
1490
|
/**
|
|
1454
1491
|
* Represents a shorthand for defining a border. It can be a combination of size, optionally followed by color, optionally followed by style.
|
|
1492
|
+
* @publicDocs
|
|
1455
1493
|
*/
|
|
1456
1494
|
export type BorderShorthand =
|
|
1457
1495
|
| BorderSizeKeyword
|
|
@@ -1535,6 +1573,7 @@ export interface BorderProps {
|
|
|
1535
1573
|
*/
|
|
1536
1574
|
borderRadius?: MaybeAllValuesShorthandProperty<BorderRadiusKeyword>;
|
|
1537
1575
|
}
|
|
1576
|
+
/** @publicDocs */
|
|
1538
1577
|
export interface OverflowProps {
|
|
1539
1578
|
/**
|
|
1540
1579
|
* The overflow behavior of the element.
|
|
@@ -1548,6 +1587,7 @@ export interface OverflowProps {
|
|
|
1548
1587
|
*/
|
|
1549
1588
|
overflow?: 'hidden' | 'visible';
|
|
1550
1589
|
}
|
|
1590
|
+
/** @publicDocs */
|
|
1551
1591
|
export interface BaseBoxProps
|
|
1552
1592
|
extends AccessibilityVisibilityProps,
|
|
1553
1593
|
BackgroundProps,
|
|
@@ -1565,10 +1605,12 @@ export interface BaseBoxProps
|
|
|
1565
1605
|
*/
|
|
1566
1606
|
accessibilityLabel?: string;
|
|
1567
1607
|
}
|
|
1608
|
+
/** @publicDocs */
|
|
1568
1609
|
export interface BaseBoxPropsWithRole
|
|
1569
1610
|
extends BaseBoxProps,
|
|
1570
1611
|
AccessibilityRoleProps {}
|
|
1571
1612
|
interface BoxProps$1 extends BaseBoxPropsWithRole, GlobalProps {}
|
|
1613
|
+
/** @publicDocs */
|
|
1572
1614
|
export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
|
|
1573
1615
|
/**
|
|
1574
1616
|
* The behavior of the button component.
|
|
@@ -1601,6 +1643,7 @@ export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
|
|
|
1601
1643
|
*/
|
|
1602
1644
|
loading?: boolean;
|
|
1603
1645
|
}
|
|
1646
|
+
/** @publicDocs */
|
|
1604
1647
|
export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
|
|
1605
1648
|
/**
|
|
1606
1649
|
* The URL to navigate to when clicked. The `click` event fires first, then navigation occurs. If `commandFor` is also set, the command executes instead of navigation.
|
|
@@ -1639,6 +1682,7 @@ export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
|
|
|
1639
1682
|
*/
|
|
1640
1683
|
onClick?: (event: Event) => void;
|
|
1641
1684
|
}
|
|
1685
|
+
/** @publicDocs */
|
|
1642
1686
|
export interface InteractionProps {
|
|
1643
1687
|
/**
|
|
1644
1688
|
* 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).
|
|
@@ -1663,6 +1707,7 @@ export interface InteractionProps {
|
|
|
1663
1707
|
*/
|
|
1664
1708
|
interestFor?: string;
|
|
1665
1709
|
}
|
|
1710
|
+
/** @publicDocs */
|
|
1666
1711
|
export interface BaseClickableProps
|
|
1667
1712
|
extends ButtonBehaviorProps,
|
|
1668
1713
|
LinkBehaviorProps {}
|
|
@@ -1740,6 +1785,7 @@ interface ButtonGroupProps$1 extends GlobalProps, ActionSlots {
|
|
|
1740
1785
|
*/
|
|
1741
1786
|
accessibilityLabel?: string;
|
|
1742
1787
|
}
|
|
1788
|
+
/** @publicDocs */
|
|
1743
1789
|
export interface BaseInputProps {
|
|
1744
1790
|
/**
|
|
1745
1791
|
* 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.
|
|
@@ -1752,6 +1798,7 @@ export interface BaseInputProps {
|
|
|
1752
1798
|
*/
|
|
1753
1799
|
disabled?: boolean;
|
|
1754
1800
|
}
|
|
1801
|
+
/** @publicDocs */
|
|
1755
1802
|
export interface InputProps extends BaseInputProps {
|
|
1756
1803
|
/**
|
|
1757
1804
|
* A callback fired when the user has finished editing the 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).
|
|
@@ -1769,6 +1816,7 @@ export interface InputProps extends BaseInputProps {
|
|
|
1769
1816
|
*/
|
|
1770
1817
|
defaultValue?: string;
|
|
1771
1818
|
}
|
|
1819
|
+
/** @publicDocs */
|
|
1772
1820
|
export interface MultipleInputProps extends BaseInputProps {
|
|
1773
1821
|
/**
|
|
1774
1822
|
* 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).
|
|
@@ -1783,6 +1831,7 @@ export interface MultipleInputProps extends BaseInputProps {
|
|
|
1783
1831
|
*/
|
|
1784
1832
|
values?: string[];
|
|
1785
1833
|
}
|
|
1834
|
+
/** @publicDocs */
|
|
1786
1835
|
export interface FileInputProps extends BaseInputProps {
|
|
1787
1836
|
/**
|
|
1788
1837
|
* A callback fired when the user has finished selecting one or more files.
|
|
@@ -1812,6 +1861,7 @@ export interface FileInputProps extends BaseInputProps {
|
|
|
1812
1861
|
*/
|
|
1813
1862
|
files?: ReadonlyArray<File>;
|
|
1814
1863
|
}
|
|
1864
|
+
/** @publicDocs */
|
|
1815
1865
|
export interface FieldErrorProps {
|
|
1816
1866
|
/**
|
|
1817
1867
|
* An error message displayed below the checkbox to indicate validation problems.
|
|
@@ -1819,6 +1869,7 @@ export interface FieldErrorProps {
|
|
|
1819
1869
|
*/
|
|
1820
1870
|
error?: string;
|
|
1821
1871
|
}
|
|
1872
|
+
/** @publicDocs */
|
|
1822
1873
|
export interface BasicFieldProps
|
|
1823
1874
|
extends FieldErrorProps,
|
|
1824
1875
|
LabelAccessibilityVisibilityProps {
|
|
@@ -1834,6 +1885,7 @@ export interface BasicFieldProps
|
|
|
1834
1885
|
*/
|
|
1835
1886
|
label?: string;
|
|
1836
1887
|
}
|
|
1888
|
+
/** @publicDocs */
|
|
1837
1889
|
export interface FieldDetailsProps {
|
|
1838
1890
|
/**
|
|
1839
1891
|
* Supplementary text displayed below the checkbox to provide additional context, instructions, or help.
|
|
@@ -1842,6 +1894,7 @@ export interface FieldDetailsProps {
|
|
|
1842
1894
|
*/
|
|
1843
1895
|
details?: string;
|
|
1844
1896
|
}
|
|
1897
|
+
/** @publicDocs */
|
|
1845
1898
|
export interface FieldProps
|
|
1846
1899
|
extends BasicFieldProps,
|
|
1847
1900
|
InputProps,
|
|
@@ -1852,6 +1905,7 @@ export interface FieldProps
|
|
|
1852
1905
|
*/
|
|
1853
1906
|
placeholder?: string;
|
|
1854
1907
|
}
|
|
1908
|
+
/** @publicDocs */
|
|
1855
1909
|
export interface BaseTextFieldProps extends FieldProps {
|
|
1856
1910
|
/**
|
|
1857
1911
|
* Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.
|
|
@@ -1860,6 +1914,7 @@ export interface BaseTextFieldProps extends FieldProps {
|
|
|
1860
1914
|
*/
|
|
1861
1915
|
readOnly?: boolean;
|
|
1862
1916
|
}
|
|
1917
|
+
/** @publicDocs */
|
|
1863
1918
|
export interface FieldDecorationProps {
|
|
1864
1919
|
/**
|
|
1865
1920
|
* A non-editable text value displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as `@shopify.com` or `%`.
|
|
@@ -1891,6 +1946,7 @@ export interface FieldDecorationProps {
|
|
|
1891
1946
|
*/
|
|
1892
1947
|
accessory?: ComponentChildren;
|
|
1893
1948
|
}
|
|
1949
|
+
/** @publicDocs */
|
|
1894
1950
|
export interface NumberConstraintsProps {
|
|
1895
1951
|
/**
|
|
1896
1952
|
* The highest decimal or integer value accepted for the field. When used with `step`, the value rounds down to the maximum number.
|
|
@@ -1929,6 +1985,7 @@ export interface NumberConstraintsProps {
|
|
|
1929
1985
|
*/
|
|
1930
1986
|
controls?: 'auto' | 'stepper' | 'none';
|
|
1931
1987
|
}
|
|
1988
|
+
/** @publicDocs */
|
|
1932
1989
|
export interface MinMaxLengthProps {
|
|
1933
1990
|
/**
|
|
1934
1991
|
* The maximum number of characters allowed in the field.
|
|
@@ -1943,6 +2000,7 @@ export interface MinMaxLengthProps {
|
|
|
1943
2000
|
*/
|
|
1944
2001
|
minLength?: number;
|
|
1945
2002
|
}
|
|
2003
|
+
/** @publicDocs */
|
|
1946
2004
|
export interface BaseSelectableProps {
|
|
1947
2005
|
/**
|
|
1948
2006
|
* 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.
|
|
@@ -1961,6 +2019,7 @@ export interface BaseSelectableProps {
|
|
|
1961
2019
|
*/
|
|
1962
2020
|
value?: string;
|
|
1963
2021
|
}
|
|
2022
|
+
/** @publicDocs */
|
|
1964
2023
|
export interface BaseOptionProps extends BaseSelectableProps {
|
|
1965
2024
|
/**
|
|
1966
2025
|
* Whether the option is currently selected. Use this for controlled components where you manage the selection state.
|
|
@@ -1978,6 +2037,7 @@ export interface BaseOptionProps extends BaseSelectableProps {
|
|
|
1978
2037
|
*/
|
|
1979
2038
|
defaultSelected?: boolean;
|
|
1980
2039
|
}
|
|
2040
|
+
/** @publicDocs */
|
|
1981
2041
|
export interface BaseCheckableProps
|
|
1982
2042
|
extends BaseSelectableProps,
|
|
1983
2043
|
InteractionProps {
|
|
@@ -2055,6 +2115,7 @@ interface CheckboxProps$1
|
|
|
2055
2115
|
*/
|
|
2056
2116
|
required?: boolean;
|
|
2057
2117
|
}
|
|
2118
|
+
/** @publicDocs */
|
|
2058
2119
|
export interface ChipProps$1 extends GlobalProps {
|
|
2059
2120
|
/**
|
|
2060
2121
|
* The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.
|
|
@@ -2263,6 +2324,7 @@ interface ColorPickerProps$1
|
|
|
2263
2324
|
*/
|
|
2264
2325
|
defaultValue?: string;
|
|
2265
2326
|
}
|
|
2327
|
+
/** @publicDocs */
|
|
2266
2328
|
export interface AutocompleteProps<
|
|
2267
2329
|
AutocompleteField extends AnyAutocompleteField,
|
|
2268
2330
|
> {
|
|
@@ -2300,14 +2362,17 @@ export interface AutocompleteProps<
|
|
|
2300
2362
|
*
|
|
2301
2363
|
* Commonly used when there are multiple fields with the same autocomplete needs
|
|
2302
2364
|
* in the same page. For example: 2 shipping address forms in the same page.
|
|
2365
|
+
* @publicDocs
|
|
2303
2366
|
*/
|
|
2304
2367
|
export type AutocompleteSection = `section-${string}`;
|
|
2305
2368
|
/**
|
|
2306
2369
|
* The contact information group the autocomplete data should be sourced from.
|
|
2370
|
+
* @publicDocs
|
|
2307
2371
|
*/
|
|
2308
2372
|
export type AutocompleteGroup = 'shipping' | 'billing';
|
|
2309
2373
|
/**
|
|
2310
2374
|
* The contact information subgroup the autocomplete data should be sourced from.
|
|
2375
|
+
* @publicDocs
|
|
2311
2376
|
*/
|
|
2312
2377
|
export type AutocompleteAddressGroup = 'fax' | 'home' | 'mobile' | 'pager';
|
|
2313
2378
|
/**
|
|
@@ -2315,6 +2380,7 @@ export type AutocompleteAddressGroup = 'fax' | 'home' | 'mobile' | 'pager';
|
|
|
2315
2380
|
* These values help browsers provide appropriate autofill suggestions for form fields.
|
|
2316
2381
|
*
|
|
2317
2382
|
* Learn more about [autocomplete values](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete).
|
|
2383
|
+
* @publicDocs
|
|
2318
2384
|
*/
|
|
2319
2385
|
export type AnyAutocompleteField =
|
|
2320
2386
|
| 'additional-name'
|
|
@@ -2416,6 +2482,7 @@ export type AnyAutocompleteField =
|
|
|
2416
2482
|
* - `cc-additional-name` - Middle name on credit card
|
|
2417
2483
|
* - `cc-family-name` - Last name on credit card
|
|
2418
2484
|
* - `cc-type` - Credit card type (Visa, Mastercard)
|
|
2485
|
+
* @publicDocs
|
|
2419
2486
|
*/
|
|
2420
2487
|
export type TextAutocompleteField = ExtractStrict<
|
|
2421
2488
|
AnyAutocompleteField,
|
|
@@ -2644,6 +2711,7 @@ interface DateFieldProps$1
|
|
|
2644
2711
|
* - `cc-expiry` - Complete credit card expiration date
|
|
2645
2712
|
* - `cc-expiry-month` - Month component of a credit card expiration date (1-12)
|
|
2646
2713
|
* - `cc-expiry-year` - Year component of a credit card expiration date (2025)
|
|
2714
|
+
* @publicDocs
|
|
2647
2715
|
*/
|
|
2648
2716
|
export type DateAutocompleteField = ExtractStrict<
|
|
2649
2717
|
AnyAutocompleteField,
|
|
@@ -2721,6 +2789,7 @@ interface EmailFieldProps$1
|
|
|
2721
2789
|
* - `mobile email` - Mobile device email address
|
|
2722
2790
|
* - `fax email` - Fax machine email address
|
|
2723
2791
|
* - `pager email` - Pager device email address
|
|
2792
|
+
* @publicDocs
|
|
2724
2793
|
*/
|
|
2725
2794
|
export type EmailAutocompleteField = ExtractStrict<
|
|
2726
2795
|
AnyAutocompleteField,
|
|
@@ -2783,6 +2852,7 @@ interface FunctionSettingsProps$1 extends GlobalProps, FormProps$1 {
|
|
|
2783
2852
|
* These errors are returned when the extension-provided data fails validation or causes
|
|
2784
2853
|
* issues during the commit process to Shopify's servers. Handle these errors in the
|
|
2785
2854
|
* `onError` callback to provide feedback to users about what went wrong.
|
|
2855
|
+
* @publicDocs
|
|
2786
2856
|
*/
|
|
2787
2857
|
export interface FunctionSettingsError extends Error {
|
|
2788
2858
|
/**
|
|
@@ -2802,6 +2872,7 @@ export interface FunctionSettingsError extends Error {
|
|
|
2802
2872
|
}
|
|
2803
2873
|
/**
|
|
2804
2874
|
* Defines the spacing size between elements, using the standard size scale or `none` for no spacing.
|
|
2875
|
+
* @publicDocs
|
|
2805
2876
|
*/
|
|
2806
2877
|
export type SpacingKeyword = SizeKeyword | 'none';
|
|
2807
2878
|
export interface GapProps {
|
|
@@ -2836,6 +2907,7 @@ export interface GapProps {
|
|
|
2836
2907
|
* - `baseline`: Aligns to the baseline of the parent.
|
|
2837
2908
|
* - `first baseline`: Aligns to the first baseline of the parent.
|
|
2838
2909
|
* - `last baseline`: Aligns to the last baseline of the parent.
|
|
2910
|
+
* @publicDocs
|
|
2839
2911
|
*/
|
|
2840
2912
|
export type BaselinePosition = 'baseline' | 'first baseline' | 'last baseline';
|
|
2841
2913
|
/**
|
|
@@ -2844,6 +2916,7 @@ export type BaselinePosition = 'baseline' | 'first baseline' | 'last baseline';
|
|
|
2844
2916
|
* - `space-around`: Distributes items evenly with equal space around each item.
|
|
2845
2917
|
* - `space-evenly`: Distributes items evenly with equal space between them.
|
|
2846
2918
|
* - `stretch`: Stretches items to fill the container.
|
|
2919
|
+
* @publicDocs
|
|
2847
2920
|
*/
|
|
2848
2921
|
export type ContentDistribution =
|
|
2849
2922
|
| 'space-between'
|
|
@@ -2855,11 +2928,13 @@ export type ContentDistribution =
|
|
|
2855
2928
|
* - `center`: Centers the content.
|
|
2856
2929
|
* - `start`: Aligns content to the start.
|
|
2857
2930
|
* - `end`: Aligns content to the end.
|
|
2931
|
+
* @publicDocs
|
|
2858
2932
|
*/
|
|
2859
2933
|
export type ContentPosition = 'center' | 'start' | 'end';
|
|
2860
2934
|
/**
|
|
2861
2935
|
* Represents content positioning with overflow behavior control.
|
|
2862
2936
|
* Use `safe` to prevent content from becoming inaccessible when it overflows, or `unsafe` to allow overflow regardless of accessibility.
|
|
2937
|
+
* @publicDocs
|
|
2863
2938
|
*/
|
|
2864
2939
|
export type OverflowPosition =
|
|
2865
2940
|
| `unsafe ${ContentPosition}`
|
|
@@ -2868,6 +2943,7 @@ export type OverflowPosition =
|
|
|
2868
2943
|
* Justify items defines the default justify-self for all items of the box, giving them all a default way of justifying each box along the appropriate axis.
|
|
2869
2944
|
*
|
|
2870
2945
|
* Learn more about the [justify-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).
|
|
2946
|
+
* @publicDocs
|
|
2871
2947
|
*/
|
|
2872
2948
|
export type JustifyItemsKeyword =
|
|
2873
2949
|
| 'normal'
|
|
@@ -2879,6 +2955,7 @@ export type JustifyItemsKeyword =
|
|
|
2879
2955
|
* Align items sets the align-self value on all direct children as a group.
|
|
2880
2956
|
*
|
|
2881
2957
|
* Learn more about the [align-items property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).
|
|
2958
|
+
* @publicDocs
|
|
2882
2959
|
*/
|
|
2883
2960
|
export type AlignItemsKeyword =
|
|
2884
2961
|
| 'normal'
|
|
@@ -2890,6 +2967,7 @@ export type AlignItemsKeyword =
|
|
|
2890
2967
|
* Justify content defines how the browser distributes space between and around content items along the main-axis of a flex container, and the inline axis of a grid container.
|
|
2891
2968
|
*
|
|
2892
2969
|
* Learn more about the [justify-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).
|
|
2970
|
+
* @publicDocs
|
|
2893
2971
|
*/
|
|
2894
2972
|
export type JustifyContentKeyword =
|
|
2895
2973
|
| 'normal'
|
|
@@ -2900,6 +2978,7 @@ export type JustifyContentKeyword =
|
|
|
2900
2978
|
* Align content sets the distribution of space between and around content items along a flexbox's cross axis, or a grid or block-level element's block axis.
|
|
2901
2979
|
*
|
|
2902
2980
|
* Learn more about the [align-content property](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).
|
|
2981
|
+
* @publicDocs
|
|
2903
2982
|
*/
|
|
2904
2983
|
export type AlignContentKeyword =
|
|
2905
2984
|
| 'normal'
|
|
@@ -3015,6 +3094,7 @@ interface GridItemProps$1 extends GlobalProps, BaseBoxPropsWithRole {
|
|
|
3015
3094
|
*/
|
|
3016
3095
|
gridRow?: `span ${number}` | 'auto';
|
|
3017
3096
|
}
|
|
3097
|
+
/** @publicDocs */
|
|
3018
3098
|
export interface BaseTypographyProps {
|
|
3019
3099
|
/**
|
|
3020
3100
|
* The color emphasis level that controls visual intensity.
|
|
@@ -3077,6 +3157,7 @@ export interface BaseTypographyProps {
|
|
|
3077
3157
|
*/
|
|
3078
3158
|
dir?: 'ltr' | 'rtl' | 'auto' | '';
|
|
3079
3159
|
}
|
|
3160
|
+
/** @publicDocs */
|
|
3080
3161
|
export interface BlockTypographyProps {
|
|
3081
3162
|
/**
|
|
3082
3163
|
* The maximum number of lines to display before truncating the text content.
|
|
@@ -3151,6 +3232,7 @@ interface IconProps$1
|
|
|
3151
3232
|
*/
|
|
3152
3233
|
type?: IconType | AnyString;
|
|
3153
3234
|
}
|
|
3235
|
+
/** @publicDocs */
|
|
3154
3236
|
export interface BaseImageProps {
|
|
3155
3237
|
/**
|
|
3156
3238
|
* Alternative text that describes the image for accessibility.
|
|
@@ -3365,6 +3447,7 @@ interface MoneyFieldProps$1
|
|
|
3365
3447
|
/**
|
|
3366
3448
|
* Represents autocomplete values that are valid for money/currency input fields.
|
|
3367
3449
|
* This is a subset of `AnyAutocompleteField` containing only fields suitable for monetary inputs.
|
|
3450
|
+
* @publicDocs
|
|
3368
3451
|
*/
|
|
3369
3452
|
export type MoneyAutocompleteField = ExtractStrict<
|
|
3370
3453
|
AnyAutocompleteField,
|
|
@@ -3404,6 +3487,7 @@ interface NumberFieldProps$1
|
|
|
3404
3487
|
* - `one-time-code` - One-time codes for authentication (OTP, 2FA codes)
|
|
3405
3488
|
* - `cc-number` - Credit card number
|
|
3406
3489
|
* - `cc-csc` - Credit card security code (CVV/CVC)
|
|
3490
|
+
* @publicDocs
|
|
3407
3491
|
*/
|
|
3408
3492
|
export type NumberAutocompleteField = ExtractStrict<
|
|
3409
3493
|
AnyAutocompleteField,
|
|
@@ -3486,6 +3570,7 @@ interface ParagraphProps$1
|
|
|
3486
3570
|
*/
|
|
3487
3571
|
type?: ParagraphType;
|
|
3488
3572
|
}
|
|
3573
|
+
/** @publicDocs */
|
|
3489
3574
|
export type ParagraphType =
|
|
3490
3575
|
/**
|
|
3491
3576
|
* A semantic type that indicates the text is a structural grouping of related content.
|
|
@@ -3515,6 +3600,7 @@ interface PasswordFieldProps$1
|
|
|
3515
3600
|
* Available values:
|
|
3516
3601
|
* - `current-password` - Existing password for login or authentication
|
|
3517
3602
|
* - `new-password` - New password when creating an account or changing password
|
|
3603
|
+
* @publicDocs
|
|
3518
3604
|
*/
|
|
3519
3605
|
export type PasswordAutocompleteField = ExtractStrict<
|
|
3520
3606
|
AnyAutocompleteField,
|
|
@@ -3654,6 +3740,7 @@ interface SwitchProps$1
|
|
|
3654
3740
|
BasicFieldProps,
|
|
3655
3741
|
FieldDetailsProps,
|
|
3656
3742
|
FieldErrorProps {}
|
|
3743
|
+
/** @publicDocs */
|
|
3657
3744
|
export interface PaginationProps {
|
|
3658
3745
|
/**
|
|
3659
3746
|
* Whether to use pagination controls.
|
|
@@ -3730,6 +3817,7 @@ interface TableCellProps$1 extends GlobalProps {
|
|
|
3730
3817
|
* - `kicker`: A small label or tag displayed above the primary content.
|
|
3731
3818
|
* - `inline`: Content displayed inline with the primary content.
|
|
3732
3819
|
* - `labeled`: Content with an associated label.
|
|
3820
|
+
* @publicDocs
|
|
3733
3821
|
*/
|
|
3734
3822
|
export type ListSlotType =
|
|
3735
3823
|
| 'primary'
|
|
@@ -3744,6 +3832,7 @@ export type ListSlotType =
|
|
|
3744
3832
|
* - `base`: Standard format for text columns
|
|
3745
3833
|
* - `currency`: Right-aligned format for monetary values
|
|
3746
3834
|
* - `numeric`: Right-aligned format for numeric values
|
|
3835
|
+
* @publicDocs
|
|
3747
3836
|
*/
|
|
3748
3837
|
export type HeaderFormat = 'base' | 'currency' | 'numeric';
|
|
3749
3838
|
interface TableHeaderProps$1 extends GlobalProps {
|
|
@@ -3811,6 +3900,7 @@ interface TextProps$1
|
|
|
3811
3900
|
/**
|
|
3812
3901
|
* Defines the semantic type and styling treatment for text content.
|
|
3813
3902
|
* Each type maps to appropriate HTML elements and applies specific styling for different contexts.
|
|
3903
|
+
* @publicDocs
|
|
3814
3904
|
*/
|
|
3815
3905
|
export type TextType =
|
|
3816
3906
|
/**
|
|
@@ -3945,6 +4035,7 @@ interface URLFieldProps$1
|
|
|
3945
4035
|
* - `mobile impp` - Mobile instant messaging protocol URL
|
|
3946
4036
|
* - `fax impp` - Fax instant messaging protocol URL
|
|
3947
4037
|
* - `pager impp` - Pager instant messaging protocol URL
|
|
4038
|
+
* @publicDocs
|
|
3948
4039
|
*/
|
|
3949
4040
|
export type URLAutocompleteField = ExtractStrict<
|
|
3950
4041
|
AnyAutocompleteField,
|
|
@@ -3991,6 +4082,7 @@ export interface VNode<P = {}> {
|
|
|
3991
4082
|
/**
|
|
3992
4083
|
* Represents a unique key for identifying elements in lists.
|
|
3993
4084
|
* Can be a string, number, or any other value.
|
|
4085
|
+
* @publicDocs
|
|
3994
4086
|
*/
|
|
3995
4087
|
export type Key = string | number | any;
|
|
3996
4088
|
export interface RefObject<T> {
|
|
@@ -4003,15 +4095,18 @@ export interface RefObject<T> {
|
|
|
4003
4095
|
/**
|
|
4004
4096
|
* Represents a callback function that receives a reference to a DOM element or component instance.
|
|
4005
4097
|
* Called when the element is mounted or unmounted.
|
|
4098
|
+
* @publicDocs
|
|
4006
4099
|
*/
|
|
4007
4100
|
export type RefCallback<T> = (instance: T | null) => void;
|
|
4008
4101
|
/**
|
|
4009
4102
|
* Represents a reference to a DOM element or component instance.
|
|
4010
4103
|
* Can be either a ref object, callback function, or null.
|
|
4104
|
+
* @publicDocs
|
|
4011
4105
|
*/
|
|
4012
4106
|
export type Ref<T> = RefObject<T> | RefCallback<T> | null;
|
|
4013
4107
|
/**
|
|
4014
4108
|
* Represents a single child element that can be rendered, including VNodes, primitives, or null/undefined values.
|
|
4109
|
+
* @publicDocs
|
|
4015
4110
|
*/
|
|
4016
4111
|
export type ComponentChild =
|
|
4017
4112
|
| VNode<any>
|
|
@@ -4033,6 +4128,7 @@ export interface Attributes {
|
|
|
4033
4128
|
*/
|
|
4034
4129
|
jsx?: boolean | undefined;
|
|
4035
4130
|
}
|
|
4131
|
+
/** @publicDocs */
|
|
4036
4132
|
export interface ErrorInfo {
|
|
4037
4133
|
/**
|
|
4038
4134
|
* A string representation of the component stack trace at the point where an error occurred.
|
|
@@ -4042,6 +4138,7 @@ export interface ErrorInfo {
|
|
|
4042
4138
|
}
|
|
4043
4139
|
/**
|
|
4044
4140
|
* Represents the props that can be rendered by a component, combining custom props with standard attributes like children and ref.
|
|
4141
|
+
* @publicDocs
|
|
4045
4142
|
*/
|
|
4046
4143
|
export type RenderableProps<P, RefType = any> = P &
|
|
4047
4144
|
Readonly<
|
|
@@ -4058,6 +4155,7 @@ export type RenderableProps<P, RefType = any> = P &
|
|
|
4058
4155
|
>;
|
|
4059
4156
|
/**
|
|
4060
4157
|
* Represents any valid component type, either a class component or a function component.
|
|
4158
|
+
* @publicDocs
|
|
4061
4159
|
*/
|
|
4062
4160
|
export type ComponentType<P = {}> = ComponentClass<P> | FunctionComponent<P>;
|
|
4063
4161
|
export interface FunctionComponent<P = {}> {
|
|
@@ -4071,6 +4169,7 @@ export interface FunctionComponent<P = {}> {
|
|
|
4071
4169
|
*/
|
|
4072
4170
|
defaultProps?: Partial<P> | undefined;
|
|
4073
4171
|
}
|
|
4172
|
+
/** @publicDocs */
|
|
4074
4173
|
export interface ComponentClass<P = {}, S = {}> {
|
|
4075
4174
|
new (props: P, context?: any): Component<P, S>;
|
|
4076
4175
|
/**
|
|
@@ -4091,6 +4190,7 @@ export interface ComponentClass<P = {}, S = {}> {
|
|
|
4091
4190
|
): Partial<S> | null;
|
|
4092
4191
|
getDerivedStateFromError?(error: any): Partial<S> | null;
|
|
4093
4192
|
}
|
|
4193
|
+
/** @publicDocs */
|
|
4094
4194
|
export interface Component<P = {}, S = {}> {
|
|
4095
4195
|
componentWillMount?(): void;
|
|
4096
4196
|
componentDidMount?(): void;
|
|
@@ -4179,6 +4279,7 @@ export interface Consumer<T>
|
|
|
4179
4279
|
*/
|
|
4180
4280
|
children: (value: T) => ComponentChildren$1;
|
|
4181
4281
|
}> {}
|
|
4282
|
+
/** @publicDocs */
|
|
4182
4283
|
export interface Provider<T>
|
|
4183
4284
|
extends FunctionComponent<{
|
|
4184
4285
|
/**
|
|
@@ -4190,6 +4291,7 @@ export interface Provider<T>
|
|
|
4190
4291
|
*/
|
|
4191
4292
|
children?: ComponentChildren$1;
|
|
4192
4293
|
}> {}
|
|
4294
|
+
/** @publicDocs */
|
|
4193
4295
|
export interface Context<T> extends Provider<T> {
|
|
4194
4296
|
/**
|
|
4195
4297
|
* A component that consumes the context value and re-renders when it changes.
|
|
@@ -4751,11 +4853,13 @@ export interface AvatarProps
|
|
|
4751
4853
|
|
|
4752
4854
|
/**
|
|
4753
4855
|
* Represents CSS styles as a string, typically used for inline styles or style injection.
|
|
4856
|
+
* @publicDocs
|
|
4754
4857
|
*/
|
|
4755
4858
|
export type Styles = string;
|
|
4756
4859
|
/**
|
|
4757
4860
|
* Represents the implementation details for rendering components within a shadow DOM.
|
|
4758
4861
|
* Extends `ShadowRootInit` with a render function and optional styles.
|
|
4862
|
+
* @publicDocs
|
|
4759
4863
|
*/
|
|
4760
4864
|
export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
|
|
4761
4865
|
ShadowRoot: (element: any) => ComponentChildren;
|
|
@@ -4779,6 +4883,7 @@ export interface ActivationEventEsque {
|
|
|
4779
4883
|
*/
|
|
4780
4884
|
button: number;
|
|
4781
4885
|
}
|
|
4886
|
+
/** @publicDocs */
|
|
4782
4887
|
export interface ClickOptions {
|
|
4783
4888
|
/**
|
|
4784
4889
|
* The event you want to influence the synthetic click.
|
|
@@ -4832,6 +4937,7 @@ declare abstract class PreactCustomElement extends BaseClass$4 {
|
|
|
4832
4937
|
* An event object with a strongly-typed `currentTarget` property that references the specific HTML element that triggered the event.
|
|
4833
4938
|
*
|
|
4834
4939
|
* This type extends the standard DOM `Event` interface and ensures type safety when accessing the element that fired the event.
|
|
4940
|
+
* @publicDocs
|
|
4835
4941
|
*/
|
|
4836
4942
|
export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
|
|
4837
4943
|
currentTarget: HTMLElementTagNameMap[T];
|
|
@@ -4839,6 +4945,7 @@ export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
|
|
|
4839
4945
|
/**
|
|
4840
4946
|
* A toggle event with a strongly-typed `currentTarget` property.
|
|
4841
4947
|
* Extends the `ToggleEvent` interface with type-safe access to the element that triggered the toggle.
|
|
4948
|
+
* @publicDocs
|
|
4842
4949
|
*/
|
|
4843
4950
|
export type CallbackToggleEvent<
|
|
4844
4951
|
TTagName extends keyof HTMLElementTagNameMap,
|
|
@@ -4856,6 +4963,7 @@ export type CallbackToggleEvent<
|
|
|
4856
4963
|
* const handleClick: CallbackEventListener<'button'> = (event) => {
|
|
4857
4964
|
* console.log('Button clicked:', event.currentTarget);
|
|
4858
4965
|
* };
|
|
4966
|
+
* @publicDocs
|
|
4859
4967
|
*/
|
|
4860
4968
|
export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
|
|
4861
4969
|
| (EventListener & {
|
|
@@ -4865,6 +4973,7 @@ export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
|
|
|
4865
4973
|
/**
|
|
4866
4974
|
* A function that handles error events from UI components.
|
|
4867
4975
|
* This type represents an event listener callback that receives both the event and an error object.
|
|
4976
|
+
* @publicDocs
|
|
4868
4977
|
*/
|
|
4869
4978
|
export type CallbackErrorEventListener<
|
|
4870
4979
|
TTagName extends keyof HTMLElementTagNameMap,
|
|
@@ -4885,6 +4994,7 @@ export interface CallbackExtendableEvent<
|
|
|
4885
4994
|
/**
|
|
4886
4995
|
* A function that handles extendable events from UI components.
|
|
4887
4996
|
* This type represents an event listener callback that can use `waitUntil` to extend the event lifetime.
|
|
4997
|
+
* @publicDocs
|
|
4888
4998
|
*/
|
|
4889
4999
|
export type CallbackExtendableEventListener<
|
|
4890
5000
|
TTagName extends keyof HTMLElementTagNameMap,
|
|
@@ -4914,6 +5024,7 @@ export interface FieldReactProps<T extends keyof HTMLElementTagNameMap> {
|
|
|
4914
5024
|
/**
|
|
4915
5025
|
* Base props for Preact custom elements without children support.
|
|
4916
5026
|
* Includes common properties like key, ref, and slot for elements that don't accept child content.
|
|
5027
|
+
* @publicDocs
|
|
4917
5028
|
*/
|
|
4918
5029
|
export interface PreactBaseElementProps<TClass extends HTMLElement> {
|
|
4919
5030
|
/**
|
|
@@ -4936,6 +5047,7 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
|
|
|
4936
5047
|
/**
|
|
4937
5048
|
* Base props for Preact custom elements with children support.
|
|
4938
5049
|
* Extends PreactBaseElementProps with the ability to render child elements.
|
|
5050
|
+
* @publicDocs
|
|
4939
5051
|
*/
|
|
4940
5052
|
export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
|
|
4941
5053
|
extends PreactBaseElementProps<TClass> {
|
|
@@ -4945,6 +5057,10 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
|
|
|
4945
5057
|
children?: preact.ComponentChildren;
|
|
4946
5058
|
}
|
|
4947
5059
|
|
|
5060
|
+
/**
|
|
5061
|
+
* Configure the following properties on the avatar component.
|
|
5062
|
+
* @publicDocs
|
|
5063
|
+
*/
|
|
4948
5064
|
declare class Avatar extends PreactCustomElement implements AvatarProps {
|
|
4949
5065
|
accessor initials: AvatarProps['initials'];
|
|
4950
5066
|
accessor src: AvatarProps['src'];
|
|
@@ -5024,6 +5140,10 @@ export interface BadgeProps
|
|
|
5024
5140
|
>;
|
|
5025
5141
|
}
|
|
5026
5142
|
|
|
5143
|
+
/**
|
|
5144
|
+
* Configure the following properties on the badge component.
|
|
5145
|
+
* @publicDocs
|
|
5146
|
+
*/
|
|
5027
5147
|
declare class Badge extends PreactCustomElement implements BadgeProps {
|
|
5028
5148
|
accessor color: BadgeProps['color'];
|
|
5029
5149
|
accessor icon: BadgeProps['icon'];
|
|
@@ -5056,6 +5176,7 @@ export interface BadgeJSXProps
|
|
|
5056
5176
|
|
|
5057
5177
|
/**
|
|
5058
5178
|
* Represents the banner component props with all properties marked as required.
|
|
5179
|
+
* @publicDocs
|
|
5059
5180
|
*/
|
|
5060
5181
|
export type RequiredBannerProps = Required<BannerProps$1>;
|
|
5061
5182
|
export interface BannerProps
|
|
@@ -5069,6 +5190,10 @@ export interface BannerProps
|
|
|
5069
5190
|
>;
|
|
5070
5191
|
}
|
|
5071
5192
|
|
|
5193
|
+
/**
|
|
5194
|
+
* Configure the following properties on the banner component.
|
|
5195
|
+
* @publicDocs
|
|
5196
|
+
*/
|
|
5072
5197
|
declare class Banner extends PreactCustomElement implements BannerProps {
|
|
5073
5198
|
accessor heading: BannerProps['heading'];
|
|
5074
5199
|
accessor tone: BannerProps['tone'];
|
|
@@ -5118,6 +5243,7 @@ export interface BannerJSXProps
|
|
|
5118
5243
|
/**
|
|
5119
5244
|
* Makes a type responsive by allowing it to be either the base value or a container query string.
|
|
5120
5245
|
* This enables conditional styling based on container dimensions.
|
|
5246
|
+
* @publicDocs
|
|
5121
5247
|
*/
|
|
5122
5248
|
export type MakeResponsive<T> = T | `@container${string}`;
|
|
5123
5249
|
/**
|
|
@@ -5135,6 +5261,7 @@ export type MakeResponsive<T> = T | `@container${string}`;
|
|
|
5135
5261
|
* margin: string | `@container${string}`;
|
|
5136
5262
|
* padding: number | `@container${string}`;
|
|
5137
5263
|
* }
|
|
5264
|
+
* @publicDocs
|
|
5138
5265
|
*/
|
|
5139
5266
|
export type MakeResponsivePick<TType, TProperty extends keyof TType> = {
|
|
5140
5267
|
[P in TProperty]: MakeResponsive<TType[P]>;
|
|
@@ -5142,6 +5269,7 @@ export type MakeResponsivePick<TType, TProperty extends keyof TType> = {
|
|
|
5142
5269
|
|
|
5143
5270
|
/**
|
|
5144
5271
|
* Represents the box component props with all properties marked as required.
|
|
5272
|
+
* @publicDocs
|
|
5145
5273
|
*/
|
|
5146
5274
|
export type RequiredBoxProps = Required<BoxProps$1>;
|
|
5147
5275
|
/**
|
|
@@ -5155,6 +5283,7 @@ export type RequiredBoxProps = Required<BoxProps$1>;
|
|
|
5155
5283
|
* - `large-100`: Large radius for more prominent corner rounding.
|
|
5156
5284
|
* - `large-200`: Extra large radius for maximum rounding.
|
|
5157
5285
|
* - `none`: No border radius (sharp corners).
|
|
5286
|
+
* @publicDocs
|
|
5158
5287
|
*/
|
|
5159
5288
|
export type BoxBorderRadii = Extract<
|
|
5160
5289
|
RequiredBoxProps['borderRadius'],
|
|
@@ -5174,6 +5303,7 @@ export type BoxBorderRadii = Extract<
|
|
|
5174
5303
|
* - `none`: No border style (removes the border).
|
|
5175
5304
|
* - `solid`: Continuous line border.
|
|
5176
5305
|
* - `dashed`: Border made up of dashes.
|
|
5306
|
+
* @publicDocs
|
|
5177
5307
|
*/
|
|
5178
5308
|
export type BoxBorderStyles = Extract<
|
|
5179
5309
|
RequiredBoxProps['borderStyle'],
|
|
@@ -5183,6 +5313,7 @@ export type BoxBorderStyles = Extract<
|
|
|
5183
5313
|
* Represents box props with responsive capabilities for layout properties.
|
|
5184
5314
|
*
|
|
5185
5315
|
* This enables conditional styling based on container queries.
|
|
5316
|
+
* @publicDocs
|
|
5186
5317
|
*/
|
|
5187
5318
|
export type ResponsiveBoxProps = MakeResponsivePick<
|
|
5188
5319
|
RequiredBoxProps,
|
|
@@ -5451,6 +5582,10 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
|
|
|
5451
5582
|
accessor display: BoxProps['display'];
|
|
5452
5583
|
}
|
|
5453
5584
|
|
|
5585
|
+
/**
|
|
5586
|
+
* Configure the following properties on the box component.
|
|
5587
|
+
* @publicDocs
|
|
5588
|
+
*/
|
|
5454
5589
|
declare class Box extends BoxElement implements BoxProps {
|
|
5455
5590
|
constructor();
|
|
5456
5591
|
}
|
|
@@ -5480,6 +5615,7 @@ export interface BoxJSXProps
|
|
|
5480
5615
|
/**
|
|
5481
5616
|
* Represents button props that are specific to button-type elements only.
|
|
5482
5617
|
* Extracts the subset of `ButtonProps` that includes the `type` property.
|
|
5618
|
+
* @publicDocs
|
|
5483
5619
|
*/
|
|
5484
5620
|
export type ButtonOnlyProps = Extract<
|
|
5485
5621
|
ButtonProps$1,
|
|
@@ -5489,6 +5625,7 @@ export type ButtonOnlyProps = Extract<
|
|
|
5489
5625
|
>;
|
|
5490
5626
|
/**
|
|
5491
5627
|
* Represents the base button props with all properties marked as required.
|
|
5628
|
+
* @publicDocs
|
|
5492
5629
|
*/
|
|
5493
5630
|
export type ButtonBaseProps = Required<
|
|
5494
5631
|
Pick<
|
|
@@ -5544,6 +5681,10 @@ declare const Button_base: (abstract new (
|
|
|
5544
5681
|
args_0: RenderImpl,
|
|
5545
5682
|
) => PreactCustomElement & PreactOverlayControlProps) &
|
|
5546
5683
|
Pick<typeof PreactCustomElement, 'prototype' | 'observedAttributes'>;
|
|
5684
|
+
/**
|
|
5685
|
+
* Configure the following properties on the button component.
|
|
5686
|
+
* @publicDocs
|
|
5687
|
+
*/
|
|
5547
5688
|
declare class Button extends Button_base implements ButtonProps {
|
|
5548
5689
|
accessor disabled: ButtonProps['disabled'];
|
|
5549
5690
|
accessor icon: ButtonProps['icon'];
|
|
@@ -5595,6 +5736,10 @@ export interface ButtonJSXProps
|
|
|
5595
5736
|
export interface ButtonGroupProps
|
|
5596
5737
|
extends Required<Pick<ButtonGroupProps$1, 'gap' | 'accessibilityLabel'>> {}
|
|
5597
5738
|
|
|
5739
|
+
/**
|
|
5740
|
+
* Configure the following properties on the button group component.
|
|
5741
|
+
* @publicDocs
|
|
5742
|
+
*/
|
|
5598
5743
|
declare class ButtonGroup
|
|
5599
5744
|
extends PreactCustomElement
|
|
5600
5745
|
implements ButtonGroupProps
|
|
@@ -5648,6 +5793,7 @@ declare const internals$4: unique symbol;
|
|
|
5648
5793
|
/**
|
|
5649
5794
|
* Represents the essential input props required for Preact-based input elements.
|
|
5650
5795
|
* Includes properties like `disabled`, `id`, `name`, and `value`.
|
|
5796
|
+
* @publicDocs
|
|
5651
5797
|
*/
|
|
5652
5798
|
export type PreactInputProps = Required<
|
|
5653
5799
|
Pick<TextFieldProps$1, 'disabled' | 'id' | 'name' | 'value'>
|
|
@@ -5733,6 +5879,10 @@ export interface CheckboxProps extends PreactCheckboxProps {
|
|
|
5733
5879
|
defaultIndeterminate: Required<CheckboxProps$1>['defaultIndeterminate'];
|
|
5734
5880
|
}
|
|
5735
5881
|
|
|
5882
|
+
/**
|
|
5883
|
+
* Configure the following properties on the checkbox component.
|
|
5884
|
+
* @publicDocs
|
|
5885
|
+
*/
|
|
5736
5886
|
declare class Checkbox extends PreactCheckboxElement implements CheckboxProps {
|
|
5737
5887
|
get indeterminate(): CheckboxProps['indeterminate'];
|
|
5738
5888
|
set indeterminate(indeterminate: CheckboxProps['indeterminate']);
|
|
@@ -5769,6 +5919,10 @@ export interface CheckboxJSXProps
|
|
|
5769
5919
|
export interface ChipProps
|
|
5770
5920
|
extends Required<Pick<ChipProps$2, 'color' | 'accessibilityLabel'>> {}
|
|
5771
5921
|
|
|
5922
|
+
/**
|
|
5923
|
+
* Configure the following properties on the chip component.
|
|
5924
|
+
* @publicDocs
|
|
5925
|
+
*/
|
|
5772
5926
|
declare class Chip extends PreactCustomElement implements ChipProps {
|
|
5773
5927
|
accessor color: ChipProps['color'];
|
|
5774
5928
|
accessor accessibilityLabel: ChipProps['accessibilityLabel'];
|
|
@@ -5814,6 +5968,12 @@ export interface ChoiceProps
|
|
|
5814
5968
|
>
|
|
5815
5969
|
> {}
|
|
5816
5970
|
|
|
5971
|
+
/**
|
|
5972
|
+
* 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.
|
|
5973
|
+
*
|
|
5974
|
+
* Choice components support labels, help text, and custom content through slots, providing flexible option presentation within choice lists.
|
|
5975
|
+
* @publicDocs
|
|
5976
|
+
*/
|
|
5817
5977
|
declare class Choice extends PreactCustomElement implements ChoiceProps {
|
|
5818
5978
|
accessor disabled: ChoiceProps['disabled'];
|
|
5819
5979
|
get selected(): boolean;
|
|
@@ -5886,6 +6046,10 @@ declare class BaseClass$3 extends PreactCustomElement {
|
|
|
5886
6046
|
/** @private */
|
|
5887
6047
|
[internals$3]: ElementInternals;
|
|
5888
6048
|
}
|
|
6049
|
+
/**
|
|
6050
|
+
* Configure the following properties on the choice list component.
|
|
6051
|
+
* @publicDocs
|
|
6052
|
+
*/
|
|
5889
6053
|
declare class ChoiceList extends BaseClass$3 implements ChoiceListProps {
|
|
5890
6054
|
accessor disabled: ChoiceListProps['disabled'];
|
|
5891
6055
|
accessor name: ChoiceListProps['name'];
|
|
@@ -5940,6 +6104,7 @@ export interface ChoiceListJSXProps
|
|
|
5940
6104
|
|
|
5941
6105
|
/**
|
|
5942
6106
|
* Represents the base clickable props with all properties marked as required.
|
|
6107
|
+
* @publicDocs
|
|
5943
6108
|
*/
|
|
5944
6109
|
export type ClickableBaseProps = Required<
|
|
5945
6110
|
Pick<
|
|
@@ -5965,6 +6130,10 @@ declare const Clickable_base: (abstract new (
|
|
|
5965
6130
|
renderImpl: RenderImpl,
|
|
5966
6131
|
) => BoxElement & PreactOverlayControlProps) &
|
|
5967
6132
|
Pick<typeof BoxElement, 'prototype' | 'observedAttributes'>;
|
|
6133
|
+
/**
|
|
6134
|
+
* Configure the following properties on the clickable component.
|
|
6135
|
+
* @publicDocs
|
|
6136
|
+
*/
|
|
5968
6137
|
declare class Clickable extends Clickable_base implements ClickableProps {
|
|
5969
6138
|
accessor disabled: ClickableProps['disabled'];
|
|
5970
6139
|
accessor loading: ClickableProps['loading'];
|
|
@@ -6030,6 +6199,10 @@ declare const ClickableChip_base: (abstract new (
|
|
|
6030
6199
|
args_0: RenderImpl,
|
|
6031
6200
|
) => PreactCustomElement & PreactOverlayControlProps) &
|
|
6032
6201
|
Pick<typeof PreactCustomElement, 'prototype' | 'observedAttributes'>;
|
|
6202
|
+
/**
|
|
6203
|
+
* Configure the following properties on the clickable chip component.
|
|
6204
|
+
* @publicDocs
|
|
6205
|
+
*/
|
|
6033
6206
|
declare class ClickableChip
|
|
6034
6207
|
extends ClickableChip_base
|
|
6035
6208
|
implements ClickableChipProps
|
|
@@ -6085,6 +6258,7 @@ export interface ClickableChipJSXProps
|
|
|
6085
6258
|
/**
|
|
6086
6259
|
* Represents the props for Preact-based form field components with autocomplete support.
|
|
6087
6260
|
* The generic type parameter allows specifying the valid autocomplete values for the field.
|
|
6261
|
+
* @publicDocs
|
|
6088
6262
|
*/
|
|
6089
6263
|
export type PreactFieldProps<Autocomplete extends string = string> =
|
|
6090
6264
|
PreactInputProps &
|
|
@@ -6168,6 +6342,7 @@ declare class PreactFieldElement<Autocomplete extends string = string>
|
|
|
6168
6342
|
/**
|
|
6169
6343
|
* Represents the props for color input field components.
|
|
6170
6344
|
* Extends `PreactFieldProps` with autocomplete support for color-related fields.
|
|
6345
|
+
* @publicDocs
|
|
6171
6346
|
*/
|
|
6172
6347
|
export type ColorFieldProps = Omit<
|
|
6173
6348
|
PreactFieldProps<Required<ColorFieldProps$1>['autocomplete']>,
|
|
@@ -6175,6 +6350,10 @@ export type ColorFieldProps = Omit<
|
|
|
6175
6350
|
> &
|
|
6176
6351
|
Required<Pick<ColorFieldProps$1, 'alpha' | 'value' | 'defaultValue'>>;
|
|
6177
6352
|
|
|
6353
|
+
/**
|
|
6354
|
+
* Configure the following properties on the color field component.
|
|
6355
|
+
* @publicDocs
|
|
6356
|
+
*/
|
|
6178
6357
|
declare class ColorField
|
|
6179
6358
|
extends PreactFieldElement<ColorFieldProps['autocomplete']>
|
|
6180
6359
|
implements ColorFieldProps
|
|
@@ -6224,6 +6403,10 @@ declare class BaseClass$2 extends PreactCustomElement {
|
|
|
6224
6403
|
/** @private */
|
|
6225
6404
|
[internals$2]: ElementInternals;
|
|
6226
6405
|
}
|
|
6406
|
+
/**
|
|
6407
|
+
* Configure the following properties on the color picker component.
|
|
6408
|
+
* @publicDocs
|
|
6409
|
+
*/
|
|
6227
6410
|
declare class ColorPicker extends BaseClass$2 implements ColorPickerProps {
|
|
6228
6411
|
accessor alpha: boolean;
|
|
6229
6412
|
accessor name: string;
|
|
@@ -6279,6 +6462,10 @@ export interface DateFieldProps
|
|
|
6279
6462
|
>
|
|
6280
6463
|
> {}
|
|
6281
6464
|
|
|
6465
|
+
/**
|
|
6466
|
+
* Configure the following properties on the date field component.
|
|
6467
|
+
* @publicDocs
|
|
6468
|
+
*/
|
|
6282
6469
|
declare class DateField
|
|
6283
6470
|
extends PreactFieldElement<DateFieldProps['autocomplete']>
|
|
6284
6471
|
implements DateFieldProps
|
|
@@ -6369,6 +6556,10 @@ declare class BaseClass$1 extends PreactCustomElement {
|
|
|
6369
6556
|
/** @private */
|
|
6370
6557
|
[internals$1]: ElementInternals;
|
|
6371
6558
|
}
|
|
6559
|
+
/**
|
|
6560
|
+
* Configure the following properties on the date picker component.
|
|
6561
|
+
* @publicDocs
|
|
6562
|
+
*/
|
|
6372
6563
|
declare class DatePicker extends BaseClass$1 implements DatePickerProps {
|
|
6373
6564
|
accessor defaultView: string;
|
|
6374
6565
|
set view(view: string);
|
|
@@ -6433,6 +6624,10 @@ export interface DividerProps
|
|
|
6433
6624
|
color: Extract<DividerProps$1['color'], 'base' | 'strong'>;
|
|
6434
6625
|
}
|
|
6435
6626
|
|
|
6627
|
+
/**
|
|
6628
|
+
* Configure the following properties on the divider component.
|
|
6629
|
+
* @publicDocs
|
|
6630
|
+
*/
|
|
6436
6631
|
declare class Divider extends PreactCustomElement implements DividerProps {
|
|
6437
6632
|
accessor direction: DividerProps['direction'];
|
|
6438
6633
|
accessor color: DividerProps['color'];
|
|
@@ -6477,6 +6672,7 @@ export interface DropZoneProps
|
|
|
6477
6672
|
/**
|
|
6478
6673
|
* A utility type that replaces occurrences of one type with another within a union type.
|
|
6479
6674
|
* Useful for type transformations where you need to swap out specific types.
|
|
6675
|
+
* @publicDocs
|
|
6480
6676
|
*/
|
|
6481
6677
|
export type ReplaceType<TType, TFrom, TTo> = Exclude<TType, TFrom> | TTo;
|
|
6482
6678
|
|
|
@@ -6490,6 +6686,10 @@ declare class BaseClass extends PreactCustomElement {
|
|
|
6490
6686
|
/** @private */
|
|
6491
6687
|
[internals]: ElementInternals;
|
|
6492
6688
|
}
|
|
6689
|
+
/**
|
|
6690
|
+
* Configure the following properties on the drop zone component.
|
|
6691
|
+
* @publicDocs
|
|
6692
|
+
*/
|
|
6493
6693
|
declare class DropZone extends BaseClass implements DropZoneProps {
|
|
6494
6694
|
accessor accept: DropZoneProps['accept'];
|
|
6495
6695
|
accessor accessibilityLabel: DropZoneProps['accessibilityLabel'];
|
|
@@ -6557,12 +6757,17 @@ export interface DropZoneJSXProps
|
|
|
6557
6757
|
/**
|
|
6558
6758
|
* Represents the props for email input field components.
|
|
6559
6759
|
* Extends `PreactFieldProps` with autocomplete support for email-related fields.
|
|
6760
|
+
* @publicDocs
|
|
6560
6761
|
*/
|
|
6561
6762
|
export type EmailFieldProps = PreactFieldProps<
|
|
6562
6763
|
Required<EmailFieldProps$1>['autocomplete']
|
|
6563
6764
|
> &
|
|
6564
6765
|
Required<Pick<EmailFieldProps$1, 'maxLength' | 'minLength'>>;
|
|
6565
6766
|
|
|
6767
|
+
/**
|
|
6768
|
+
* Configure the following properties on the email field component.
|
|
6769
|
+
* @publicDocs
|
|
6770
|
+
*/
|
|
6566
6771
|
declare class EmailField
|
|
6567
6772
|
extends PreactFieldElement<EmailFieldProps['autocomplete']>
|
|
6568
6773
|
implements EmailFieldProps
|
|
@@ -6598,12 +6803,14 @@ export interface EmailFieldJSXProps
|
|
|
6598
6803
|
|
|
6599
6804
|
/**
|
|
6600
6805
|
* Represents the grid component props with all properties marked as required.
|
|
6806
|
+
* @publicDocs
|
|
6601
6807
|
*/
|
|
6602
6808
|
export type RequiredAlignedProps = Required<GridProps$1>;
|
|
6603
6809
|
/**
|
|
6604
6810
|
* Represents grid props with responsive capabilities for layout properties.
|
|
6605
6811
|
*
|
|
6606
6812
|
* This enables conditional styling based on container queries.
|
|
6813
|
+
* @publicDocs
|
|
6607
6814
|
*/
|
|
6608
6815
|
export type ResponsiveGridProps = MakeResponsivePick<
|
|
6609
6816
|
RequiredAlignedProps,
|
|
@@ -6713,6 +6920,10 @@ export interface GridProps
|
|
|
6713
6920
|
gridTemplateRows: ResponsiveGridProps['gridTemplateRows'];
|
|
6714
6921
|
}
|
|
6715
6922
|
|
|
6923
|
+
/**
|
|
6924
|
+
* Configure the following properties on the grid component.
|
|
6925
|
+
* @publicDocs
|
|
6926
|
+
*/
|
|
6716
6927
|
declare class Grid extends BoxElement implements GridProps {
|
|
6717
6928
|
constructor();
|
|
6718
6929
|
accessor gridTemplateColumns: GridProps['gridTemplateColumns'];
|
|
@@ -6752,6 +6963,7 @@ export interface GridJSXProps
|
|
|
6752
6963
|
|
|
6753
6964
|
/**
|
|
6754
6965
|
* Represents the grid item component props with all properties marked as required.
|
|
6966
|
+
* @publicDocs
|
|
6755
6967
|
*/
|
|
6756
6968
|
export type RequiredGridItemProps = Required<GridItemProps$1>;
|
|
6757
6969
|
export interface GridItemProps
|
|
@@ -6761,6 +6973,12 @@ export interface GridItemProps
|
|
|
6761
6973
|
gridRow: RequiredGridItemProps['gridRow'];
|
|
6762
6974
|
}
|
|
6763
6975
|
|
|
6976
|
+
/**
|
|
6977
|
+
* 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.
|
|
6978
|
+
*
|
|
6979
|
+
* Grid 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.
|
|
6980
|
+
* @publicDocs
|
|
6981
|
+
*/
|
|
6764
6982
|
declare class GridItem extends BoxElement implements GridItemProps {
|
|
6765
6983
|
accessor gridColumn: GridItemProps['gridColumn'];
|
|
6766
6984
|
accessor gridRow: GridItemProps['gridRow'];
|
|
@@ -6798,6 +7016,10 @@ export interface HeadingProps
|
|
|
6798
7016
|
>
|
|
6799
7017
|
> {}
|
|
6800
7018
|
|
|
7019
|
+
/**
|
|
7020
|
+
* Configure the following properties on the heading component.
|
|
7021
|
+
* @publicDocs
|
|
7022
|
+
*/
|
|
6801
7023
|
declare class Heading extends PreactCustomElement implements HeadingProps {
|
|
6802
7024
|
accessor accessibilityRole: HeadingProps['accessibilityRole'];
|
|
6803
7025
|
accessor lineClamp: HeadingProps['lineClamp'];
|
|
@@ -6828,6 +7050,10 @@ export interface HeadingJSXProps
|
|
|
6828
7050
|
children?: ComponentChildren;
|
|
6829
7051
|
}
|
|
6830
7052
|
|
|
7053
|
+
/**
|
|
7054
|
+
* Configure the following properties on the icon component.
|
|
7055
|
+
* @publicDocs
|
|
7056
|
+
*/
|
|
6831
7057
|
declare class Icon extends PreactCustomElement implements IconProps {
|
|
6832
7058
|
accessor color: IconProps['color'];
|
|
6833
7059
|
accessor tone: IconProps['tone'];
|
|
@@ -6880,6 +7106,10 @@ export interface ImageProps
|
|
|
6880
7106
|
>
|
|
6881
7107
|
> {}
|
|
6882
7108
|
|
|
7109
|
+
/**
|
|
7110
|
+
* Configure the following properties on the image component.
|
|
7111
|
+
* @publicDocs
|
|
7112
|
+
*/
|
|
6883
7113
|
declare class Image extends PreactCustomElement implements ImageProps {
|
|
6884
7114
|
accessor src: ImageProps['src'];
|
|
6885
7115
|
accessor srcSet: ImageProps['srcSet'];
|
|
@@ -6941,10 +7171,12 @@ export interface ImageJSXProps
|
|
|
6941
7171
|
|
|
6942
7172
|
/**
|
|
6943
7173
|
* Represents the link component props with all properties marked as required.
|
|
7174
|
+
* @publicDocs
|
|
6944
7175
|
*/
|
|
6945
7176
|
export type RequiredLinkProps = Required<LinkProps$1>;
|
|
6946
7177
|
/**
|
|
6947
7178
|
* Represents the base link props with all core properties marked as required.
|
|
7179
|
+
* @publicDocs
|
|
6948
7180
|
*/
|
|
6949
7181
|
export type LinkBaseProps = Required<
|
|
6950
7182
|
Pick<
|
|
@@ -6968,6 +7200,10 @@ declare const Link_base: (abstract new (
|
|
|
6968
7200
|
args_0: RenderImpl,
|
|
6969
7201
|
) => PreactCustomElement & PreactOverlayControlProps) &
|
|
6970
7202
|
Pick<typeof PreactCustomElement, 'prototype' | 'observedAttributes'>;
|
|
7203
|
+
/**
|
|
7204
|
+
* Configure the following properties on the link component.
|
|
7205
|
+
* @publicDocs
|
|
7206
|
+
*/
|
|
6971
7207
|
declare class Link extends Link_base implements LinkProps {
|
|
6972
7208
|
accessor tone: LinkProps['tone'];
|
|
6973
7209
|
accessor accessibilityLabel: LinkProps['accessibilityLabel'];
|
|
@@ -7006,6 +7242,12 @@ export interface LinkJSXProps
|
|
|
7006
7242
|
|
|
7007
7243
|
export interface ListItemProps extends ListItemProps$1 {}
|
|
7008
7244
|
|
|
7245
|
+
/**
|
|
7246
|
+
* 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.
|
|
7247
|
+
*
|
|
7248
|
+
* List 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.
|
|
7249
|
+
* @publicDocs
|
|
7250
|
+
*/
|
|
7009
7251
|
declare class ListItem extends PreactCustomElement implements ListItemProps {
|
|
7010
7252
|
constructor();
|
|
7011
7253
|
}
|
|
@@ -7053,6 +7295,7 @@ declare const overlayHideFrameId: unique symbol;
|
|
|
7053
7295
|
/**
|
|
7054
7296
|
* Represents the initialization object for creating a polyfill command event.
|
|
7055
7297
|
* Used for overlay control commands in environments that require polyfills.
|
|
7298
|
+
* @publicDocs
|
|
7056
7299
|
*/
|
|
7057
7300
|
export type PolyfillCommandEventInit = EventInit & {
|
|
7058
7301
|
source: HTMLElement | null | undefined;
|
|
@@ -7061,6 +7304,7 @@ export type PolyfillCommandEventInit = EventInit & {
|
|
|
7061
7304
|
/**
|
|
7062
7305
|
* Represents a polyfill command event for overlay controls.
|
|
7063
7306
|
* Used in environments where native command events are not available.
|
|
7307
|
+
* @publicDocs
|
|
7064
7308
|
*/
|
|
7065
7309
|
export type PolyfillCommandEvent = Event & {
|
|
7066
7310
|
source: PolyfillCommandEventInit['source'];
|
|
@@ -7084,6 +7328,10 @@ declare class PreactOverlayElement extends PreactCustomElement {
|
|
|
7084
7328
|
[overlayHideFrameId]?: number;
|
|
7085
7329
|
}
|
|
7086
7330
|
|
|
7331
|
+
/**
|
|
7332
|
+
* Configure the following properties on the menu component.
|
|
7333
|
+
* @publicDocs
|
|
7334
|
+
*/
|
|
7087
7335
|
declare class Menu extends PreactOverlayElement implements MenuProps {
|
|
7088
7336
|
accessor accessibilityLabel: string;
|
|
7089
7337
|
constructor();
|
|
@@ -7117,6 +7365,7 @@ export interface MenuJSXProps
|
|
|
7117
7365
|
|
|
7118
7366
|
/**
|
|
7119
7367
|
* Represents the modal component props with all properties marked as required.
|
|
7368
|
+
* @publicDocs
|
|
7120
7369
|
*/
|
|
7121
7370
|
export type RequiredAlignedModalProps = Required<ModalProps$1>;
|
|
7122
7371
|
export interface ModalProps
|
|
@@ -7160,6 +7409,7 @@ declare class AddedContext<T> extends EventTarget {
|
|
|
7160
7409
|
/**
|
|
7161
7410
|
* A callback which is provided by a context requester and is called with the value satisfying the request.
|
|
7162
7411
|
* This callback can be called multiple times by context providers as the requested value is changed.
|
|
7412
|
+
* @publicDocs
|
|
7163
7413
|
*/
|
|
7164
7414
|
export type ContextCallback<T> = (value: T) => void;
|
|
7165
7415
|
/**
|
|
@@ -7198,6 +7448,10 @@ declare const abortController: unique symbol;
|
|
|
7198
7448
|
declare const onChildModalChange: unique symbol;
|
|
7199
7449
|
declare const childrenRerenderObserver: unique symbol;
|
|
7200
7450
|
declare const shadowDomRerenderObserver: unique symbol;
|
|
7451
|
+
/**
|
|
7452
|
+
* Configure the following properties on the modal component.
|
|
7453
|
+
* @publicDocs
|
|
7454
|
+
*/
|
|
7201
7455
|
declare class Modal extends PreactOverlayElement implements ModalProps {
|
|
7202
7456
|
accessor accessibilityLabel: ModalProps['accessibilityLabel'];
|
|
7203
7457
|
accessor heading: ModalProps['heading'];
|
|
@@ -7294,6 +7548,7 @@ export interface ModalJSXProps
|
|
|
7294
7548
|
|
|
7295
7549
|
/**
|
|
7296
7550
|
* Represents the money field component props with all properties marked as required.
|
|
7551
|
+
* @publicDocs
|
|
7297
7552
|
*/
|
|
7298
7553
|
export type RequiredMoneyFieldProps = Required<MoneyFieldProps$1>;
|
|
7299
7554
|
export interface MoneyFieldProps
|
|
@@ -7302,6 +7557,10 @@ export interface MoneyFieldProps
|
|
|
7302
7557
|
value: Required<MoneyFieldProps$1>['value'];
|
|
7303
7558
|
}
|
|
7304
7559
|
|
|
7560
|
+
/**
|
|
7561
|
+
* Configure the following properties on the money field component.
|
|
7562
|
+
* @publicDocs
|
|
7563
|
+
*/
|
|
7305
7564
|
declare class MoneyField
|
|
7306
7565
|
extends PreactFieldElement<MoneyFieldProps['autocomplete']>
|
|
7307
7566
|
implements MoneyFieldProps
|
|
@@ -7348,6 +7607,10 @@ export interface NumberFieldProps
|
|
|
7348
7607
|
value: Required<NumberFieldProps$1>['value'];
|
|
7349
7608
|
}
|
|
7350
7609
|
|
|
7610
|
+
/**
|
|
7611
|
+
* Configure the following properties on the number field component.
|
|
7612
|
+
* @publicDocs
|
|
7613
|
+
*/
|
|
7351
7614
|
declare class NumberField
|
|
7352
7615
|
extends PreactFieldElement<NumberFieldProps['autocomplete']>
|
|
7353
7616
|
implements NumberFieldProps
|
|
@@ -7389,6 +7652,10 @@ export interface OptionProps
|
|
|
7389
7652
|
Pick<OptionProps$1, 'disabled' | 'value' | 'selected' | 'defaultSelected'>
|
|
7390
7653
|
> {}
|
|
7391
7654
|
|
|
7655
|
+
/**
|
|
7656
|
+
* Represents a single option within a select component. Use only as a child of s-select components.
|
|
7657
|
+
* @publicDocs
|
|
7658
|
+
*/
|
|
7392
7659
|
declare class Option extends PreactCustomElement implements OptionProps {
|
|
7393
7660
|
accessor selected: OptionProps['selected'];
|
|
7394
7661
|
accessor defaultSelected: OptionProps['defaultSelected'];
|
|
@@ -7422,6 +7689,10 @@ export interface OptionJSXProps
|
|
|
7422
7689
|
export interface OptionGroupProps
|
|
7423
7690
|
extends Required<Pick<OptionGroupProps$1, 'disabled' | 'label'>> {}
|
|
7424
7691
|
|
|
7692
|
+
/**
|
|
7693
|
+
* Represents a group of options within a select component. Use only as a child of `s-select` components.
|
|
7694
|
+
* @publicDocs
|
|
7695
|
+
*/
|
|
7425
7696
|
declare class OptionGroup
|
|
7426
7697
|
extends PreactCustomElement
|
|
7427
7698
|
implements OptionGroupProps
|
|
@@ -7456,6 +7727,10 @@ export interface OptionGroupJSXProps
|
|
|
7456
7727
|
|
|
7457
7728
|
export interface OrderedListProps extends OrderedListProps$1 {}
|
|
7458
7729
|
|
|
7730
|
+
/**
|
|
7731
|
+
* Configure the following properties on the ordered list component.
|
|
7732
|
+
* @publicDocs
|
|
7733
|
+
*/
|
|
7459
7734
|
declare class OrderedList
|
|
7460
7735
|
extends PreactCustomElement
|
|
7461
7736
|
implements OrderedListProps
|
|
@@ -7491,6 +7766,10 @@ export interface PageProps
|
|
|
7491
7766
|
inlineSize: Extract<PageProps$1['inlineSize'], 'base' | 'large' | 'small'>;
|
|
7492
7767
|
}
|
|
7493
7768
|
|
|
7769
|
+
/**
|
|
7770
|
+
* Use as the outer wrapper of a page.
|
|
7771
|
+
* @publicDocs
|
|
7772
|
+
*/
|
|
7494
7773
|
declare class Page extends PreactCustomElement implements PageProps {
|
|
7495
7774
|
accessor inlineSize: PageProps['inlineSize'];
|
|
7496
7775
|
accessor heading: PageProps['heading'];
|
|
@@ -7580,6 +7859,10 @@ export interface ParagraphProps
|
|
|
7580
7859
|
color: Extract<ParagraphProps$1['color'], 'base' | 'subdued'>;
|
|
7581
7860
|
}
|
|
7582
7861
|
|
|
7862
|
+
/**
|
|
7863
|
+
* Configure the following properties on the paragraph component.
|
|
7864
|
+
* @publicDocs
|
|
7865
|
+
*/
|
|
7583
7866
|
declare class Paragraph extends PreactCustomElement implements ParagraphProps {
|
|
7584
7867
|
accessor fontVariantNumeric: ParagraphProps['fontVariantNumeric'];
|
|
7585
7868
|
accessor lineClamp: ParagraphProps['lineClamp'];
|
|
@@ -7626,6 +7909,7 @@ export interface ParagraphJSXProps
|
|
|
7626
7909
|
/**
|
|
7627
7910
|
* Represents the props for password input field components.
|
|
7628
7911
|
* Extends `PreactFieldProps` with autocomplete support for password-related fields.
|
|
7912
|
+
* @publicDocs
|
|
7629
7913
|
*/
|
|
7630
7914
|
export type PasswordFieldProps = PreactFieldProps<
|
|
7631
7915
|
Required<PasswordFieldProps$1>['autocomplete']
|
|
@@ -7649,6 +7933,10 @@ export type PasswordFieldProps = PreactFieldProps<
|
|
|
7649
7933
|
>
|
|
7650
7934
|
>;
|
|
7651
7935
|
|
|
7936
|
+
/**
|
|
7937
|
+
* Configure the following properties on the password field component.
|
|
7938
|
+
* @publicDocs
|
|
7939
|
+
*/
|
|
7652
7940
|
declare class PasswordField
|
|
7653
7941
|
extends PreactFieldElement<PasswordFieldProps['autocomplete']>
|
|
7654
7942
|
implements PasswordFieldProps
|
|
@@ -7708,6 +7996,10 @@ declare class PreactPopoverElement<TTagName extends keyof HTMLElementTagNameMap>
|
|
|
7708
7996
|
accessor maxInlineSize: BoxProps['maxInlineSize'];
|
|
7709
7997
|
}
|
|
7710
7998
|
|
|
7999
|
+
/**
|
|
8000
|
+
* Configure the following properties on the popover component.
|
|
8001
|
+
* @publicDocs
|
|
8002
|
+
*/
|
|
7711
8003
|
declare class Popover
|
|
7712
8004
|
extends PreactPopoverElement<typeof tagName$p>
|
|
7713
8005
|
implements PopoverProps
|
|
@@ -7765,6 +8057,10 @@ export interface PopoverJSXProps
|
|
|
7765
8057
|
export interface QueryContainerProps
|
|
7766
8058
|
extends Required<Pick<QueryContainerProps$1, 'id' | 'containerName'>> {}
|
|
7767
8059
|
|
|
8060
|
+
/**
|
|
8061
|
+
* Configure the following properties on the query container component.
|
|
8062
|
+
* @publicDocs
|
|
8063
|
+
*/
|
|
7768
8064
|
declare class QueryContainer
|
|
7769
8065
|
extends PreactCustomElement
|
|
7770
8066
|
implements QueryContainerProps
|
|
@@ -7801,6 +8097,7 @@ export interface QueryContainerJSXProps
|
|
|
7801
8097
|
/**
|
|
7802
8098
|
* Represents the props for search input field components.
|
|
7803
8099
|
* Extends `PreactFieldProps` for search-specific functionality.
|
|
8100
|
+
* @publicDocs
|
|
7804
8101
|
*/
|
|
7805
8102
|
export type SearchFieldProps = PreactFieldProps<
|
|
7806
8103
|
/**
|
|
@@ -7827,6 +8124,10 @@ export type SearchFieldProps = PreactFieldProps<
|
|
|
7827
8124
|
>
|
|
7828
8125
|
>;
|
|
7829
8126
|
|
|
8127
|
+
/**
|
|
8128
|
+
* Configure the following properties on the search field component.
|
|
8129
|
+
* @publicDocs
|
|
8130
|
+
*/
|
|
7830
8131
|
declare class SearchField
|
|
7831
8132
|
extends PreactFieldElement<SearchFieldProps['autocomplete']>
|
|
7832
8133
|
implements SearchFieldProps
|
|
@@ -7861,6 +8162,7 @@ export interface SearchFieldJSXProps
|
|
|
7861
8162
|
|
|
7862
8163
|
/**
|
|
7863
8164
|
* Represents the section component props with all properties marked as required.
|
|
8165
|
+
* @publicDocs
|
|
7864
8166
|
*/
|
|
7865
8167
|
export type RequiredSectionProps = Required<SectionProps$1>;
|
|
7866
8168
|
export interface SectionProps
|
|
@@ -7873,6 +8175,10 @@ export interface SectionProps
|
|
|
7873
8175
|
padding: RequiredSectionProps['padding'];
|
|
7874
8176
|
}
|
|
7875
8177
|
|
|
8178
|
+
/**
|
|
8179
|
+
* Configure the following properties on the section component.
|
|
8180
|
+
* @publicDocs
|
|
8181
|
+
*/
|
|
7876
8182
|
declare class Section extends PreactCustomElement implements SectionProps {
|
|
7877
8183
|
constructor();
|
|
7878
8184
|
/** @private */
|
|
@@ -7928,6 +8234,10 @@ export interface SelectProps
|
|
|
7928
8234
|
declare const usedFirstOptionSymbol: unique symbol;
|
|
7929
8235
|
declare const hasInitialValueSymbol: unique symbol;
|
|
7930
8236
|
|
|
8237
|
+
/**
|
|
8238
|
+
* Configure the following properties on the select component.
|
|
8239
|
+
* @publicDocs
|
|
8240
|
+
*/
|
|
7931
8241
|
declare class Select extends PreactInputElement implements SelectProps {
|
|
7932
8242
|
accessor icon: SelectProps['icon'];
|
|
7933
8243
|
accessor details: SelectProps['details'];
|
|
@@ -8002,6 +8312,10 @@ export interface SpinnerProps
|
|
|
8002
8312
|
size: Extract<SpinnerProps$1['size'], 'large' | 'large-100' | 'base'>;
|
|
8003
8313
|
}
|
|
8004
8314
|
|
|
8315
|
+
/**
|
|
8316
|
+
* Configure the following properties on the spinner component.
|
|
8317
|
+
* @publicDocs
|
|
8318
|
+
*/
|
|
8005
8319
|
declare class Spinner extends PreactCustomElement implements SpinnerProps {
|
|
8006
8320
|
accessor accessibilityLabel: string;
|
|
8007
8321
|
accessor size: SpinnerProps['size'];
|
|
@@ -8027,12 +8341,14 @@ export interface SpinnerJSXProps
|
|
|
8027
8341
|
|
|
8028
8342
|
/**
|
|
8029
8343
|
* Represents the stack component props with all properties marked as required.
|
|
8344
|
+
* @publicDocs
|
|
8030
8345
|
*/
|
|
8031
8346
|
export type AlignedStackProps = Required<StackProps$1>;
|
|
8032
8347
|
/**
|
|
8033
8348
|
* Represents stack props with responsive capabilities for layout properties.
|
|
8034
8349
|
*
|
|
8035
8350
|
* This enables conditional styling based on container queries.
|
|
8351
|
+
* @publicDocs
|
|
8036
8352
|
*/
|
|
8037
8353
|
export type ResponsiveStackProps = MakeResponsivePick<
|
|
8038
8354
|
AlignedStackProps,
|
|
@@ -8113,6 +8429,10 @@ export interface StackProps
|
|
|
8113
8429
|
direction: ResponsiveStackProps['direction'];
|
|
8114
8430
|
}
|
|
8115
8431
|
|
|
8432
|
+
/**
|
|
8433
|
+
* Configure the following properties on the stack component.
|
|
8434
|
+
* @publicDocs
|
|
8435
|
+
*/
|
|
8116
8436
|
declare class Stack extends BoxElement implements StackProps {
|
|
8117
8437
|
constructor();
|
|
8118
8438
|
accessor direction: StackProps['direction'];
|
|
@@ -8150,6 +8470,10 @@ export interface SwitchProps
|
|
|
8150
8470
|
extends PreactCheckboxProps,
|
|
8151
8471
|
Required<Pick<SwitchProps$1, 'labelAccessibilityVisibility'>> {}
|
|
8152
8472
|
|
|
8473
|
+
/**
|
|
8474
|
+
* Configure the following properties on the switch component.
|
|
8475
|
+
* @publicDocs
|
|
8476
|
+
*/
|
|
8153
8477
|
declare class Switch extends PreactCheckboxElement implements SwitchProps {
|
|
8154
8478
|
accessor labelAccessibilityVisibility: SwitchProps['labelAccessibilityVisibility'];
|
|
8155
8479
|
constructor();
|
|
@@ -8198,6 +8522,7 @@ export interface TableProps
|
|
|
8198
8522
|
* - `base`: Standard format for text columns
|
|
8199
8523
|
* - `currency`: Right-aligned format for monetary values
|
|
8200
8524
|
* - `numeric`: Right-aligned format for numeric values
|
|
8525
|
+
* @publicDocs
|
|
8201
8526
|
*/
|
|
8202
8527
|
export type HeaderFormat = Extract<
|
|
8203
8528
|
TableHeaderProps$1['format'],
|
|
@@ -8218,9 +8543,14 @@ declare const tableHeadersSharedDataSymbol: unique symbol;
|
|
|
8218
8543
|
* Represents the actual rendered variant of a table component.
|
|
8219
8544
|
* - `table`: Displays as a traditional table layout.
|
|
8220
8545
|
* - `list`: Displays as a list layout.
|
|
8546
|
+
* @publicDocs
|
|
8221
8547
|
*/
|
|
8222
8548
|
export type ActualTableVariant = 'table' | 'list';
|
|
8223
8549
|
|
|
8550
|
+
/**
|
|
8551
|
+
* Configure the following properties on the table component.
|
|
8552
|
+
* @publicDocs
|
|
8553
|
+
*/
|
|
8224
8554
|
declare class Table extends PreactCustomElement implements TableProps {
|
|
8225
8555
|
accessor variant: TableProps['variant'];
|
|
8226
8556
|
accessor loading: TableProps['loading'];
|
|
@@ -8273,6 +8603,12 @@ export interface TableJSXProps
|
|
|
8273
8603
|
|
|
8274
8604
|
export interface TableBodyProps extends TableBodyProps$1 {}
|
|
8275
8605
|
|
|
8606
|
+
/**
|
|
8607
|
+
* The table body component represents the main content area of a table, containing the data rows. Use table body as a child of table to structure your table data, with each table row within the body representing a single record or entry.
|
|
8608
|
+
*
|
|
8609
|
+
* Table body must contain table row components, which in turn contain table cell components for the actual data values.
|
|
8610
|
+
* @publicDocs
|
|
8611
|
+
*/
|
|
8276
8612
|
declare class TableBody extends PreactCustomElement implements TableBodyProps {
|
|
8277
8613
|
constructor();
|
|
8278
8614
|
}
|
|
@@ -8305,6 +8641,12 @@ export interface TableCellProps extends TableCellProps$1 {}
|
|
|
8305
8641
|
|
|
8306
8642
|
declare const headerFormatSymbol: unique symbol;
|
|
8307
8643
|
|
|
8644
|
+
/**
|
|
8645
|
+
* The table cell component represents a single data cell within a table row. Use table cell as a child of table row to display individual data values, with each cell corresponding to a column in the table.
|
|
8646
|
+
*
|
|
8647
|
+
* Table cell automatically inherits styling and alignment from its parent table structure and supports text content or other inline components.
|
|
8648
|
+
* @publicDocs
|
|
8649
|
+
*/
|
|
8308
8650
|
declare class TableCell extends PreactCustomElement implements TableCellProps {
|
|
8309
8651
|
constructor();
|
|
8310
8652
|
/** @private */
|
|
@@ -8336,6 +8678,12 @@ export interface TableCellJSXProps
|
|
|
8336
8678
|
children?: ComponentChildren;
|
|
8337
8679
|
}
|
|
8338
8680
|
|
|
8681
|
+
/**
|
|
8682
|
+
* The table header component represents a single column header within a table header row. Use table header as a child of table header row to define column headings and optionally enable column sorting.
|
|
8683
|
+
*
|
|
8684
|
+
* Table header provides semantic meaning for screen readers and can include sorting controls when configured. Each header corresponds to a column in the table body.
|
|
8685
|
+
* @publicDocs
|
|
8686
|
+
*/
|
|
8339
8687
|
declare class TableHeader
|
|
8340
8688
|
extends PreactCustomElement
|
|
8341
8689
|
implements TableHeaderProps
|
|
@@ -8370,6 +8718,12 @@ export interface TableHeaderJSXProps
|
|
|
8370
8718
|
|
|
8371
8719
|
export interface TableHeaderRowProps extends TableHeaderRowProps$1 {}
|
|
8372
8720
|
|
|
8721
|
+
/**
|
|
8722
|
+
* The table header row component represents the header row of a table, containing column headings. Use table header row as the first child of table (before table body) to define the table structure and provide column labels.
|
|
8723
|
+
*
|
|
8724
|
+
* Table header row must contain table header components for each column. These headers provide context for the data columns and can support sorting functionality.
|
|
8725
|
+
* @publicDocs
|
|
8726
|
+
*/
|
|
8373
8727
|
declare class TableHeaderRow
|
|
8374
8728
|
extends PreactCustomElement
|
|
8375
8729
|
implements TableHeaderRowProps
|
|
@@ -8408,6 +8762,12 @@ export interface TableHeaderRowJSXProps
|
|
|
8408
8762
|
export interface TableRowProps
|
|
8409
8763
|
extends Pick<TableRowProps$1, 'children' | 'clickDelegate'> {}
|
|
8410
8764
|
|
|
8765
|
+
/**
|
|
8766
|
+
* The table row component represents a single row of data within a table body. Use table row as a child of table body to structure individual records or entries in the table.
|
|
8767
|
+
*
|
|
8768
|
+
* Table row must contain table cell components, with each cell representing a data value for the corresponding column. The number of cells should match the number of headers in the table.
|
|
8769
|
+
* @publicDocs
|
|
8770
|
+
*/
|
|
8411
8771
|
declare class TableRow extends PreactCustomElement implements TableRowProps {
|
|
8412
8772
|
constructor();
|
|
8413
8773
|
accessor clickDelegate: string;
|
|
@@ -8490,6 +8850,10 @@ export interface TextProps
|
|
|
8490
8850
|
>;
|
|
8491
8851
|
}
|
|
8492
8852
|
|
|
8853
|
+
/**
|
|
8854
|
+
* Configure the following properties on the text component.
|
|
8855
|
+
* @publicDocs
|
|
8856
|
+
*/
|
|
8493
8857
|
declare class Text extends PreactCustomElement implements TextProps {
|
|
8494
8858
|
accessor fontVariantNumeric: TextProps['fontVariantNumeric'];
|
|
8495
8859
|
accessor color: TextProps['color'];
|
|
@@ -8545,12 +8909,17 @@ export interface TextJSXProps
|
|
|
8545
8909
|
/**
|
|
8546
8910
|
* Represents the props for textarea components.
|
|
8547
8911
|
* Extends `PreactFieldProps` for multi-line text input functionality.
|
|
8912
|
+
* @publicDocs
|
|
8548
8913
|
*/
|
|
8549
8914
|
export type TextAreaProps = PreactFieldProps<
|
|
8550
8915
|
Required<TextAreaProps$1>['autocomplete']
|
|
8551
8916
|
> &
|
|
8552
8917
|
Required<Pick<TextAreaProps$1, 'maxLength' | 'minLength' | 'rows'>>;
|
|
8553
8918
|
|
|
8919
|
+
/**
|
|
8920
|
+
* Configure the following properties on the text area component.
|
|
8921
|
+
* @publicDocs
|
|
8922
|
+
*/
|
|
8554
8923
|
declare class TextArea
|
|
8555
8924
|
extends PreactFieldElement<TextAreaProps['autocomplete']>
|
|
8556
8925
|
implements TextAreaProps
|
|
@@ -8587,6 +8956,7 @@ export interface TextAreaJSXProps
|
|
|
8587
8956
|
/**
|
|
8588
8957
|
* Represents the props for text input field components.
|
|
8589
8958
|
* Extends `PreactFieldProps` with autocomplete support for text-related fields.
|
|
8959
|
+
* @publicDocs
|
|
8590
8960
|
*/
|
|
8591
8961
|
export type TextFieldProps = PreactFieldProps<
|
|
8592
8962
|
/** @default 'on' */
|
|
@@ -8599,6 +8969,10 @@ export type TextFieldProps = PreactFieldProps<
|
|
|
8599
8969
|
>
|
|
8600
8970
|
>;
|
|
8601
8971
|
|
|
8972
|
+
/**
|
|
8973
|
+
* Configure the following properties on the text field component.
|
|
8974
|
+
* @publicDocs
|
|
8975
|
+
*/
|
|
8602
8976
|
declare class TextField
|
|
8603
8977
|
extends PreactFieldElement<TextFieldProps['autocomplete']>
|
|
8604
8978
|
implements TextFieldProps
|
|
@@ -8658,6 +9032,10 @@ export interface ThumbnailProps
|
|
|
8658
9032
|
>;
|
|
8659
9033
|
}
|
|
8660
9034
|
|
|
9035
|
+
/**
|
|
9036
|
+
* Configure the following properties on the thumbnail component.
|
|
9037
|
+
* @publicDocs
|
|
9038
|
+
*/
|
|
8661
9039
|
declare class Thumbnail extends PreactCustomElement implements ThumbnailProps {
|
|
8662
9040
|
accessor src: ThumbnailProps['src'];
|
|
8663
9041
|
accessor alt: ThumbnailProps['alt'];
|
|
@@ -8693,6 +9071,10 @@ export interface ThumbnailJSXProps
|
|
|
8693
9071
|
|
|
8694
9072
|
export interface TooltipProps extends Required<Pick<TooltipProps$1, 'id'>> {}
|
|
8695
9073
|
|
|
9074
|
+
/**
|
|
9075
|
+
* Configure the following properties on the tooltip component.
|
|
9076
|
+
* @publicDocs
|
|
9077
|
+
*/
|
|
8696
9078
|
declare class Tooltip extends PreactOverlayElement implements TooltipProps {
|
|
8697
9079
|
constructor();
|
|
8698
9080
|
}
|
|
@@ -8725,12 +9107,17 @@ export interface TooltipJSXProps
|
|
|
8725
9107
|
/**
|
|
8726
9108
|
* Represents the props for URL input field components.
|
|
8727
9109
|
* Extends `PreactFieldProps` with autocomplete support for URL-related fields.
|
|
9110
|
+
* @publicDocs
|
|
8728
9111
|
*/
|
|
8729
9112
|
export type URLFieldProps = PreactFieldProps<
|
|
8730
9113
|
Required<URLFieldProps$1>['autocomplete']
|
|
8731
9114
|
> &
|
|
8732
9115
|
Required<Pick<URLFieldProps$1, 'maxLength' | 'minLength'>>;
|
|
8733
9116
|
|
|
9117
|
+
/**
|
|
9118
|
+
* Configure the following properties on the URL field component.
|
|
9119
|
+
* @publicDocs
|
|
9120
|
+
*/
|
|
8734
9121
|
declare class URLField
|
|
8735
9122
|
extends PreactFieldElement<URLFieldProps['autocomplete']>
|
|
8736
9123
|
implements URLFieldProps
|
|
@@ -8766,6 +9153,10 @@ export interface URLFieldJSXProps
|
|
|
8766
9153
|
|
|
8767
9154
|
export interface UnorderedListProps extends UnorderedListProps$1 {}
|
|
8768
9155
|
|
|
9156
|
+
/**
|
|
9157
|
+
* Configure the following properties on the unordered list component.
|
|
9158
|
+
* @publicDocs
|
|
9159
|
+
*/
|
|
8769
9160
|
declare class UnorderedList
|
|
8770
9161
|
extends PreactCustomElement
|
|
8771
9162
|
implements UnorderedListProps
|
|
@@ -8796,6 +9187,10 @@ export interface UnorderedListJSXProps
|
|
|
8796
9187
|
children?: ComponentChildren;
|
|
8797
9188
|
}
|
|
8798
9189
|
|
|
9190
|
+
/**
|
|
9191
|
+
* Configure the following properties on the admin action component.
|
|
9192
|
+
* @publicDocs
|
|
9193
|
+
*/
|
|
8799
9194
|
export interface AdminActionProps
|
|
8800
9195
|
extends Pick<AdminActionProps$1, 'heading' | 'loading'> {}
|
|
8801
9196
|
|
|
@@ -8815,6 +9210,10 @@ export interface AdminActionJSXProps
|
|
|
8815
9210
|
secondaryActions: ComponentChildren;
|
|
8816
9211
|
}
|
|
8817
9212
|
|
|
9213
|
+
/**
|
|
9214
|
+
* Configure the following properties on the admin action component.
|
|
9215
|
+
* @publicDocs
|
|
9216
|
+
*/
|
|
8818
9217
|
declare class AdminAction
|
|
8819
9218
|
extends PreactCustomElement
|
|
8820
9219
|
implements AdminActionProps
|
|
@@ -8848,6 +9247,10 @@ declare module 'preact' {
|
|
|
8848
9247
|
}
|
|
8849
9248
|
}
|
|
8850
9249
|
|
|
9250
|
+
/**
|
|
9251
|
+
* Configure the following properties on the admin block component.
|
|
9252
|
+
* @publicDocs
|
|
9253
|
+
*/
|
|
8851
9254
|
export interface AdminBlockProps
|
|
8852
9255
|
extends Pick<AdminBlockProps$1, 'heading' | 'collapsedSummary'> {}
|
|
8853
9256
|
|
|
@@ -8856,6 +9259,10 @@ export interface AdminBlockJSXProps
|
|
|
8856
9259
|
extends Partial<AdminBlockProps>,
|
|
8857
9260
|
Pick<AdminBlockProps$1, 'id'> {}
|
|
8858
9261
|
|
|
9262
|
+
/**
|
|
9263
|
+
* Configure the following properties on the admin block component.
|
|
9264
|
+
* @publicDocs
|
|
9265
|
+
*/
|
|
8859
9266
|
declare class AdminBlock
|
|
8860
9267
|
extends PreactCustomElement
|
|
8861
9268
|
implements AdminBlockProps
|
|
@@ -8885,6 +9292,10 @@ declare module 'preact' {
|
|
|
8885
9292
|
}
|
|
8886
9293
|
}
|
|
8887
9294
|
|
|
9295
|
+
/**
|
|
9296
|
+
* Configure the following properties on the admin print action component.
|
|
9297
|
+
* @publicDocs
|
|
9298
|
+
*/
|
|
8888
9299
|
export interface AdminPrintActionProps
|
|
8889
9300
|
extends Pick<AdminPrintActionProps$1, 'src'> {}
|
|
8890
9301
|
|
|
@@ -8893,6 +9304,10 @@ export interface AdminPrintActionJSXProps
|
|
|
8893
9304
|
extends Partial<AdminPrintActionProps>,
|
|
8894
9305
|
Pick<AdminPrintActionProps$1, 'id'> {}
|
|
8895
9306
|
|
|
9307
|
+
/**
|
|
9308
|
+
* Configure the following properties on the admin print action component.
|
|
9309
|
+
* @publicDocs
|
|
9310
|
+
*/
|
|
8896
9311
|
declare class AdminPrintAction
|
|
8897
9312
|
extends PreactCustomElement
|
|
8898
9313
|
implements AdminPrintActionProps
|
|
@@ -8936,6 +9351,10 @@ export interface FormJSXProps extends Partial<FormProps> {
|
|
|
8936
9351
|
onReset?: ((event: CallbackEvent<typeof tagName$1>) => void) | null;
|
|
8937
9352
|
}
|
|
8938
9353
|
|
|
9354
|
+
/**
|
|
9355
|
+
* Configure the following properties on the form component.
|
|
9356
|
+
* @publicDocs
|
|
9357
|
+
*/
|
|
8939
9358
|
declare class Form extends PreactCustomElement implements FormProps {
|
|
8940
9359
|
constructor();
|
|
8941
9360
|
}
|
|
@@ -8980,10 +9399,15 @@ export interface FunctionSettingsJSXProps
|
|
|
8980
9399
|
/**
|
|
8981
9400
|
* Represents the event type for function settings errors.
|
|
8982
9401
|
* Extracted from the parameters of the `onFunctionSettingsError` callback.
|
|
9402
|
+
* @publicDocs
|
|
8983
9403
|
*/
|
|
8984
9404
|
export type FunctionSettingsErrorEvent = Parameters<
|
|
8985
9405
|
NonNullable<FunctionSettingsProps$1['onError']>
|
|
8986
9406
|
>[0];
|
|
9407
|
+
/**
|
|
9408
|
+
* Configure the following properties on the function settings component.
|
|
9409
|
+
* @publicDocs
|
|
9410
|
+
*/
|
|
8987
9411
|
declare class FunctionSettings
|
|
8988
9412
|
extends PreactCustomElement
|
|
8989
9413
|
implements FunctionSettingsProps
|
|
@@ -9134,6 +9558,10 @@ export type {
|
|
|
9134
9558
|
UnorderedListJSXProps,
|
|
9135
9559
|
};
|
|
9136
9560
|
|
|
9561
|
+
/**
|
|
9562
|
+
* The avatar component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
9563
|
+
* @publicDocs
|
|
9564
|
+
*/
|
|
9137
9565
|
export interface AvatarEvents {
|
|
9138
9566
|
/**
|
|
9139
9567
|
* A callback fired when the avatar image successfully loads.
|
|
@@ -9149,6 +9577,10 @@ export interface AvatarEvents {
|
|
|
9149
9577
|
error: OnErrorEventHandler = null;
|
|
9150
9578
|
}
|
|
9151
9579
|
|
|
9580
|
+
/**
|
|
9581
|
+
* The badge component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
9582
|
+
* @publicDocs
|
|
9583
|
+
*/
|
|
9152
9584
|
export interface BadgeSlots {
|
|
9153
9585
|
/**
|
|
9154
9586
|
* The text label displayed within the badge component, typically a short status indicator or category label.
|
|
@@ -9156,6 +9588,10 @@ export interface BadgeSlots {
|
|
|
9156
9588
|
children?: HTMLElement;
|
|
9157
9589
|
}
|
|
9158
9590
|
|
|
9591
|
+
/**
|
|
9592
|
+
* The banner component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
9593
|
+
* @publicDocs
|
|
9594
|
+
*/
|
|
9159
9595
|
export interface BannerEvents {
|
|
9160
9596
|
/**
|
|
9161
9597
|
* A callback fired when the banner is dismissed.
|
|
@@ -9167,6 +9603,10 @@ export interface BannerEvents {
|
|
|
9167
9603
|
afterhide: CallbackEventListener<typeof tagName> | null = null;
|
|
9168
9604
|
}
|
|
9169
9605
|
|
|
9606
|
+
/**
|
|
9607
|
+
* The banner component supports slots for additional content placement within the banner. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
9608
|
+
* @publicDocs
|
|
9609
|
+
*/
|
|
9170
9610
|
export interface BannerSlots {
|
|
9171
9611
|
/**
|
|
9172
9612
|
* The main message content displayed within the banner component, providing important information or guidance to users.
|
|
@@ -9179,6 +9619,10 @@ export interface BannerSlots {
|
|
|
9179
9619
|
'secondary-actions'?: HTMLElement;
|
|
9180
9620
|
}
|
|
9181
9621
|
|
|
9622
|
+
/**
|
|
9623
|
+
* The box component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
9624
|
+
* @publicDocs
|
|
9625
|
+
*/
|
|
9182
9626
|
export interface BoxSlots {
|
|
9183
9627
|
/**
|
|
9184
9628
|
* The content displayed within the box component, which serves as a flexible container for organizing and styling other components.
|
|
@@ -9186,6 +9630,10 @@ export interface BoxSlots {
|
|
|
9186
9630
|
children?: HTMLElement;
|
|
9187
9631
|
}
|
|
9188
9632
|
|
|
9633
|
+
/**
|
|
9634
|
+
* The button component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
9635
|
+
* @publicDocs
|
|
9636
|
+
*/
|
|
9189
9637
|
export interface ButtonEvents {
|
|
9190
9638
|
/**
|
|
9191
9639
|
* A callback fired when the button is clicked.
|
|
@@ -9207,6 +9655,10 @@ export interface ButtonEvents {
|
|
|
9207
9655
|
focus: CallbackEventListener<typeof tagName> | null = null;
|
|
9208
9656
|
}
|
|
9209
9657
|
|
|
9658
|
+
/**
|
|
9659
|
+
* The button component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
9660
|
+
* @publicDocs
|
|
9661
|
+
*/
|
|
9210
9662
|
export interface ButtonSlots {
|
|
9211
9663
|
/**
|
|
9212
9664
|
* The label text or elements displayed inside the button component, describing the action that will be performed when clicked.
|
|
@@ -9214,6 +9666,10 @@ export interface ButtonSlots {
|
|
|
9214
9666
|
children?: HTMLElement;
|
|
9215
9667
|
}
|
|
9216
9668
|
|
|
9669
|
+
/**
|
|
9670
|
+
* The button group component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
9671
|
+
* @publicDocs
|
|
9672
|
+
*/
|
|
9217
9673
|
export interface ButtonGroupSlots {
|
|
9218
9674
|
/**
|
|
9219
9675
|
* The buttons displayed within the button group component, which are arranged together as a cohesive set of related actions.
|
|
@@ -9235,6 +9691,10 @@ export interface ButtonGroupSlots {
|
|
|
9235
9691
|
'secondary-actions'?: HTMLElement;
|
|
9236
9692
|
}
|
|
9237
9693
|
|
|
9694
|
+
/**
|
|
9695
|
+
* The checkbox component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
9696
|
+
* @publicDocs
|
|
9697
|
+
*/
|
|
9238
9698
|
export interface CheckboxEvents {
|
|
9239
9699
|
/**
|
|
9240
9700
|
* A callback fired when the checkbox value changes.
|
|
@@ -9250,6 +9710,10 @@ export interface CheckboxEvents {
|
|
|
9250
9710
|
input: CallbackEventListener<'input'>;
|
|
9251
9711
|
}
|
|
9252
9712
|
|
|
9713
|
+
/**
|
|
9714
|
+
* 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).
|
|
9715
|
+
* @publicDocs
|
|
9716
|
+
*/
|
|
9253
9717
|
export interface ChipSlots {
|
|
9254
9718
|
/**
|
|
9255
9719
|
* The text label displayed within the chip component, typically representing a selected filter, tag, or removable item.
|
|
@@ -9261,6 +9725,10 @@ export interface ChipSlots {
|
|
|
9261
9725
|
graphic?: HTMLElement;
|
|
9262
9726
|
}
|
|
9263
9727
|
|
|
9728
|
+
/**
|
|
9729
|
+
* The choice list component supports slots for additional content placement within each choice. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
9730
|
+
* @publicDocs
|
|
9731
|
+
*/
|
|
9264
9732
|
export interface ChoiceSlots {
|
|
9265
9733
|
/**
|
|
9266
9734
|
* The label text or elements that identify this selectable choice to users.
|
|
@@ -9281,6 +9749,10 @@ export interface ChoiceSlots {
|
|
|
9281
9749
|
details?: HTMLElement;
|
|
9282
9750
|
}
|
|
9283
9751
|
|
|
9752
|
+
/**
|
|
9753
|
+
* 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).
|
|
9754
|
+
* @publicDocs
|
|
9755
|
+
*/
|
|
9284
9756
|
export interface ChoiceListEvents {
|
|
9285
9757
|
/**
|
|
9286
9758
|
* A callback fired when the choice list selection changes.
|
|
@@ -9296,6 +9768,10 @@ export interface ChoiceListEvents {
|
|
|
9296
9768
|
input: CallbackEventListener<typeof tagName> | null = null;
|
|
9297
9769
|
}
|
|
9298
9770
|
|
|
9771
|
+
/**
|
|
9772
|
+
* The choice list component supports slots for additional content placement within each choice. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
9773
|
+
* @publicDocs
|
|
9774
|
+
*/
|
|
9299
9775
|
export interface ChoiceListSlots {
|
|
9300
9776
|
/**
|
|
9301
9777
|
* The choices a user can select from.
|
|
@@ -9305,6 +9781,10 @@ export interface ChoiceListSlots {
|
|
|
9305
9781
|
children?: HTMLElement;
|
|
9306
9782
|
}
|
|
9307
9783
|
|
|
9784
|
+
/**
|
|
9785
|
+
* The clickable component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
9786
|
+
* @publicDocs
|
|
9787
|
+
*/
|
|
9308
9788
|
export interface ClickableEvents {
|
|
9309
9789
|
/**
|
|
9310
9790
|
* A callback fired when the component is clicked.
|
|
@@ -9326,6 +9806,10 @@ export interface ClickableEvents {
|
|
|
9326
9806
|
focus: CallbackEventListener<typeof tagName> | null = null;
|
|
9327
9807
|
}
|
|
9328
9808
|
|
|
9809
|
+
/**
|
|
9810
|
+
* The clickable component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
9811
|
+
* @publicDocs
|
|
9812
|
+
*/
|
|
9329
9813
|
export interface ClickableSlots {
|
|
9330
9814
|
/**
|
|
9331
9815
|
* The content displayed within the clickable component, which makes any content interactive and clickable without the semantic meaning of a button or link.
|
|
@@ -9333,6 +9817,10 @@ export interface ClickableSlots {
|
|
|
9333
9817
|
children?: HTMLElement;
|
|
9334
9818
|
}
|
|
9335
9819
|
|
|
9820
|
+
/**
|
|
9821
|
+
* 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).
|
|
9822
|
+
* @publicDocs
|
|
9823
|
+
*/
|
|
9336
9824
|
export interface ClickableChipEvents {
|
|
9337
9825
|
/**
|
|
9338
9826
|
* A callback fired when the chip is clicked.
|
|
@@ -9350,6 +9838,10 @@ export interface ClickableChipEvents {
|
|
|
9350
9838
|
afterhide: CallbackEventListener<typeof tagName> | null = null;
|
|
9351
9839
|
}
|
|
9352
9840
|
|
|
9841
|
+
/**
|
|
9842
|
+
* The clickable chip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
9843
|
+
* @publicDocs
|
|
9844
|
+
*/
|
|
9353
9845
|
export interface ClickableChipSlots {
|
|
9354
9846
|
/**
|
|
9355
9847
|
* The text label displayed within the chip, which represents an interactive filter, tag, or selectable item.
|
|
@@ -9361,6 +9853,10 @@ export interface ClickableChipSlots {
|
|
|
9361
9853
|
graphic?: HTMLElement;
|
|
9362
9854
|
}
|
|
9363
9855
|
|
|
9856
|
+
/**
|
|
9857
|
+
* The color field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
9858
|
+
* @publicDocs
|
|
9859
|
+
*/
|
|
9364
9860
|
export interface ColorFieldEvents {
|
|
9365
9861
|
/**
|
|
9366
9862
|
* A callback fired when the color field value changes.
|
|
@@ -9388,6 +9884,10 @@ export interface ColorFieldEvents {
|
|
|
9388
9884
|
focus: CallbackEventListener<'input'>;
|
|
9389
9885
|
}
|
|
9390
9886
|
|
|
9887
|
+
/**
|
|
9888
|
+
* The color picker component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
9889
|
+
* @publicDocs
|
|
9890
|
+
*/
|
|
9391
9891
|
export interface ColorPickerEvents {
|
|
9392
9892
|
/**
|
|
9393
9893
|
* A callback fired when the color picker value changes.
|
|
@@ -9403,6 +9903,10 @@ export interface ColorPickerEvents {
|
|
|
9403
9903
|
input: CallbackEventListener<typeof tagName> | null = null;
|
|
9404
9904
|
}
|
|
9405
9905
|
|
|
9906
|
+
/**
|
|
9907
|
+
* 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).
|
|
9908
|
+
* @publicDocs
|
|
9909
|
+
*/
|
|
9406
9910
|
export interface DateFieldEvents {
|
|
9407
9911
|
/**
|
|
9408
9912
|
* A callback fired when the date field value changes.
|
|
@@ -9440,6 +9944,10 @@ export interface DateFieldEvents {
|
|
|
9440
9944
|
invalid: CallbackEventListener<typeof tagName> | null = null;
|
|
9441
9945
|
}
|
|
9442
9946
|
|
|
9947
|
+
/**
|
|
9948
|
+
* 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).
|
|
9949
|
+
* @publicDocs
|
|
9950
|
+
*/
|
|
9443
9951
|
export interface DatePickerEvents {
|
|
9444
9952
|
/**
|
|
9445
9953
|
* A callback fired when the calendar view changes, such as when navigating between months.
|
|
@@ -9471,6 +9979,10 @@ export interface DatePickerEvents {
|
|
|
9471
9979
|
change: CallbackEventListener<typeof tagName> | null = null;
|
|
9472
9980
|
}
|
|
9473
9981
|
|
|
9982
|
+
/**
|
|
9983
|
+
* 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).
|
|
9984
|
+
* @publicDocs
|
|
9985
|
+
*/
|
|
9474
9986
|
export interface DropZoneEvents {
|
|
9475
9987
|
/**
|
|
9476
9988
|
* A callback fired when the drop zone value changes.
|
|
@@ -9490,6 +10002,10 @@ export interface DropZoneEvents {
|
|
|
9490
10002
|
droprejected: CallbackEventListener<typeof tagName> = null;
|
|
9491
10003
|
}
|
|
9492
10004
|
|
|
10005
|
+
/**
|
|
10006
|
+
* The drop zone component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10007
|
+
* @publicDocs
|
|
10008
|
+
*/
|
|
9493
10009
|
export interface DropZoneSlots {
|
|
9494
10010
|
/**
|
|
9495
10011
|
* The content to include inside the drop zone container
|
|
@@ -9497,6 +10013,10 @@ export interface DropZoneSlots {
|
|
|
9497
10013
|
children?: HTMLElement;
|
|
9498
10014
|
}
|
|
9499
10015
|
|
|
10016
|
+
/**
|
|
10017
|
+
* 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).
|
|
10018
|
+
* @publicDocs
|
|
10019
|
+
*/
|
|
9500
10020
|
export interface EmailFieldEvents {
|
|
9501
10021
|
/**
|
|
9502
10022
|
* A callback fired when the email field value changes.
|
|
@@ -9524,6 +10044,10 @@ export interface EmailFieldEvents {
|
|
|
9524
10044
|
focus: CallbackEventListener<'input'>;
|
|
9525
10045
|
}
|
|
9526
10046
|
|
|
10047
|
+
/**
|
|
10048
|
+
* The grid component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10049
|
+
* @publicDocs
|
|
10050
|
+
*/
|
|
9527
10051
|
export interface GridSlots {
|
|
9528
10052
|
/**
|
|
9529
10053
|
* The child elements displayed within the grid component, which are arranged in a flexible grid layout with configurable columns, rows, and spacing.
|
|
@@ -9531,6 +10055,10 @@ export interface GridSlots {
|
|
|
9531
10055
|
children?: HTMLElement;
|
|
9532
10056
|
}
|
|
9533
10057
|
|
|
10058
|
+
/**
|
|
10059
|
+
* The grid item component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10060
|
+
* @publicDocs
|
|
10061
|
+
*/
|
|
9534
10062
|
export interface GridItemSlots {
|
|
9535
10063
|
/**
|
|
9536
10064
|
* The content displayed within the grid item component, which represents a single cell in the grid layout and can span multiple columns or rows.
|
|
@@ -9538,6 +10066,10 @@ export interface GridItemSlots {
|
|
|
9538
10066
|
children?: HTMLElement;
|
|
9539
10067
|
}
|
|
9540
10068
|
|
|
10069
|
+
/**
|
|
10070
|
+
* The heading component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10071
|
+
* @publicDocs
|
|
10072
|
+
*/
|
|
9541
10073
|
export interface HeadingSlots {
|
|
9542
10074
|
/**
|
|
9543
10075
|
* The heading text displayed within the heading component, which provides a title or section header for content.
|
|
@@ -9545,6 +10077,10 @@ export interface HeadingSlots {
|
|
|
9545
10077
|
children?: HTMLElement;
|
|
9546
10078
|
}
|
|
9547
10079
|
|
|
10080
|
+
/**
|
|
10081
|
+
* The image component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
10082
|
+
* @publicDocs
|
|
10083
|
+
*/
|
|
9548
10084
|
export interface ImageEvents {
|
|
9549
10085
|
/**
|
|
9550
10086
|
* A callback fired when the image successfully loads.
|
|
@@ -9560,6 +10096,10 @@ export interface ImageEvents {
|
|
|
9560
10096
|
error: OnErrorEventHandler = null;
|
|
9561
10097
|
}
|
|
9562
10098
|
|
|
10099
|
+
/**
|
|
10100
|
+
* The link component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
10101
|
+
* @publicDocs
|
|
10102
|
+
*/
|
|
9563
10103
|
export interface LinkEvents {
|
|
9564
10104
|
/**
|
|
9565
10105
|
* A callback fired when the link is clicked.
|
|
@@ -9569,6 +10109,10 @@ export interface LinkEvents {
|
|
|
9569
10109
|
click: CallbackEventListener<typeof tagName> | null = null;
|
|
9570
10110
|
}
|
|
9571
10111
|
|
|
10112
|
+
/**
|
|
10113
|
+
* The link component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10114
|
+
* @publicDocs
|
|
10115
|
+
*/
|
|
9572
10116
|
export interface LinkSlots {
|
|
9573
10117
|
/**
|
|
9574
10118
|
* The text or elements displayed within the link component, which navigates users to a different location when activated.
|
|
@@ -9576,6 +10120,10 @@ export interface LinkSlots {
|
|
|
9576
10120
|
children?: HTMLElement;
|
|
9577
10121
|
}
|
|
9578
10122
|
|
|
10123
|
+
/**
|
|
10124
|
+
* The list item component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10125
|
+
* @publicDocs
|
|
10126
|
+
*/
|
|
9579
10127
|
export interface ListItemSlots {
|
|
9580
10128
|
/**
|
|
9581
10129
|
* The content displayed within the list item, which represents a single entry in an ordered or unordered list.
|
|
@@ -9583,6 +10131,10 @@ export interface ListItemSlots {
|
|
|
9583
10131
|
children?: HTMLElement;
|
|
9584
10132
|
}
|
|
9585
10133
|
|
|
10134
|
+
/**
|
|
10135
|
+
* The menu component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10136
|
+
* @publicDocs
|
|
10137
|
+
*/
|
|
9586
10138
|
export interface MenuSlots {
|
|
9587
10139
|
/**
|
|
9588
10140
|
* The items displayed within the menu. Only accepts button and section components. Use button for individual menu actions and section to group related items.
|
|
@@ -9590,6 +10142,10 @@ export interface MenuSlots {
|
|
|
9590
10142
|
children?: HTMLElement;
|
|
9591
10143
|
}
|
|
9592
10144
|
|
|
10145
|
+
/**
|
|
10146
|
+
* The modal component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
10147
|
+
* @publicDocs
|
|
10148
|
+
*/
|
|
9593
10149
|
export interface ModalEvents {
|
|
9594
10150
|
/**
|
|
9595
10151
|
* A callback fired when the modal is hidden.
|
|
@@ -9609,6 +10165,10 @@ export interface ModalEvents {
|
|
|
9609
10165
|
aftershow: CallbackEventListener<typeof tagName> | null = null;
|
|
9610
10166
|
}
|
|
9611
10167
|
|
|
10168
|
+
/**
|
|
10169
|
+
* The modal component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10170
|
+
* @publicDocs
|
|
10171
|
+
*/
|
|
9612
10172
|
export interface ModalSlots {
|
|
9613
10173
|
/**
|
|
9614
10174
|
* The content displayed within the modal component, typically including form fields, information, or interactive elements.
|
|
@@ -9628,6 +10188,10 @@ export interface ModalSlots {
|
|
|
9628
10188
|
'secondary-actions'?: HTMLElement;
|
|
9629
10189
|
}
|
|
9630
10190
|
|
|
10191
|
+
/**
|
|
10192
|
+
* 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).
|
|
10193
|
+
* @publicDocs
|
|
10194
|
+
*/
|
|
9631
10195
|
export interface MoneyFieldEvents {
|
|
9632
10196
|
/**
|
|
9633
10197
|
* A callback fired when the money field value changes.
|
|
@@ -9655,6 +10219,10 @@ export interface MoneyFieldEvents {
|
|
|
9655
10219
|
focus: CallbackEventListener<'input'>;
|
|
9656
10220
|
}
|
|
9657
10221
|
|
|
10222
|
+
/**
|
|
10223
|
+
* 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).
|
|
10224
|
+
* @publicDocs
|
|
10225
|
+
*/
|
|
9658
10226
|
export interface NumberFieldEvents {
|
|
9659
10227
|
/**
|
|
9660
10228
|
* A callback fired when the number field value changes.
|
|
@@ -9682,6 +10250,10 @@ export interface NumberFieldEvents {
|
|
|
9682
10250
|
focus: CallbackEventListener<'input'>;
|
|
9683
10251
|
}
|
|
9684
10252
|
|
|
10253
|
+
/**
|
|
10254
|
+
* The option component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10255
|
+
* @publicDocs
|
|
10256
|
+
*/
|
|
9685
10257
|
export interface OptionSlots {
|
|
9686
10258
|
/**
|
|
9687
10259
|
* The text or elements displayed as the option label, which identifies the selectable choice to users in a dropdown or selection list.
|
|
@@ -9689,6 +10261,10 @@ export interface OptionSlots {
|
|
|
9689
10261
|
children?: HTMLElement;
|
|
9690
10262
|
}
|
|
9691
10263
|
|
|
10264
|
+
/**
|
|
10265
|
+
* The option group component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10266
|
+
* @publicDocs
|
|
10267
|
+
*/
|
|
9692
10268
|
export interface OptionGroupSlots {
|
|
9693
10269
|
/**
|
|
9694
10270
|
* The selectable options displayed in the dropdown list. Accepts option components for individual selectable items within this group.
|
|
@@ -9696,6 +10272,10 @@ export interface OptionGroupSlots {
|
|
|
9696
10272
|
children?: HTMLElement;
|
|
9697
10273
|
}
|
|
9698
10274
|
|
|
10275
|
+
/**
|
|
10276
|
+
* The ordered list component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10277
|
+
* @publicDocs
|
|
10278
|
+
*/
|
|
9699
10279
|
export interface OrderedListSlots {
|
|
9700
10280
|
/**
|
|
9701
10281
|
* The list entries displayed within the ordered list, where each item is numbered sequentially. Only accepts list item components as children. Each list item represents a single numbered entry in the sequence.
|
|
@@ -9703,6 +10283,10 @@ export interface OrderedListSlots {
|
|
|
9703
10283
|
children?: HTMLElement;
|
|
9704
10284
|
}
|
|
9705
10285
|
|
|
10286
|
+
/**
|
|
10287
|
+
* The page component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10288
|
+
* @publicDocs
|
|
10289
|
+
*/
|
|
9706
10290
|
export interface PageSlots {
|
|
9707
10291
|
/**
|
|
9708
10292
|
* The main page content displayed within the page component, which serves as the primary container for the page's information and interface elements.
|
|
@@ -9735,6 +10319,10 @@ export interface PageSlots {
|
|
|
9735
10319
|
'breadcrumb-actions'?: HTMLElement;
|
|
9736
10320
|
}
|
|
9737
10321
|
|
|
10322
|
+
/**
|
|
10323
|
+
* The paragraph component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10324
|
+
* @publicDocs
|
|
10325
|
+
*/
|
|
9738
10326
|
export interface ParagraphSlots {
|
|
9739
10327
|
/**
|
|
9740
10328
|
* The paragraph text content displayed within the paragraph component, which presents a block of related text with appropriate styling.
|
|
@@ -9742,6 +10330,10 @@ export interface ParagraphSlots {
|
|
|
9742
10330
|
children?: HTMLElement;
|
|
9743
10331
|
}
|
|
9744
10332
|
|
|
10333
|
+
/**
|
|
10334
|
+
* 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).
|
|
10335
|
+
* @publicDocs
|
|
10336
|
+
*/
|
|
9745
10337
|
export interface PasswordFieldEvents {
|
|
9746
10338
|
/**
|
|
9747
10339
|
* A callback fired when the password field value changes.
|
|
@@ -9769,6 +10361,10 @@ export interface PasswordFieldEvents {
|
|
|
9769
10361
|
focus: CallbackEventListener<'input'>;
|
|
9770
10362
|
}
|
|
9771
10363
|
|
|
10364
|
+
/**
|
|
10365
|
+
* The popover component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
10366
|
+
* @publicDocs
|
|
10367
|
+
*/
|
|
9772
10368
|
export interface PopoverEvents {
|
|
9773
10369
|
/**
|
|
9774
10370
|
* A callback fired when the popover is shown.
|
|
@@ -9796,6 +10392,10 @@ export interface PopoverEvents {
|
|
|
9796
10392
|
aftertoggle: CallbackEventListener<TTagName> | null;
|
|
9797
10393
|
}
|
|
9798
10394
|
|
|
10395
|
+
/**
|
|
10396
|
+
* The popover component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10397
|
+
* @publicDocs
|
|
10398
|
+
*/
|
|
9799
10399
|
export interface PopoverSlots {
|
|
9800
10400
|
/**
|
|
9801
10401
|
* The content displayed within the popover component, which appears in an overlay positioned relative to its trigger element.
|
|
@@ -9803,6 +10403,10 @@ export interface PopoverSlots {
|
|
|
9803
10403
|
children?: HTMLElement;
|
|
9804
10404
|
}
|
|
9805
10405
|
|
|
10406
|
+
/**
|
|
10407
|
+
* The query container component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10408
|
+
* @publicDocs
|
|
10409
|
+
*/
|
|
9806
10410
|
export interface QueryContainerSlots {
|
|
9807
10411
|
/**
|
|
9808
10412
|
* The content displayed within the query container component, which enables container queries for responsive styling based on the container's size rather than the viewport.
|
|
@@ -9810,6 +10414,10 @@ export interface QueryContainerSlots {
|
|
|
9810
10414
|
children?: HTMLElement;
|
|
9811
10415
|
}
|
|
9812
10416
|
|
|
10417
|
+
/**
|
|
10418
|
+
* The search field component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
10419
|
+
* @publicDocs
|
|
10420
|
+
*/
|
|
9813
10421
|
export interface SearchFieldEvents {
|
|
9814
10422
|
/**
|
|
9815
10423
|
* A callback fired when the search field value changes.
|
|
@@ -9837,6 +10445,10 @@ export interface SearchFieldEvents {
|
|
|
9837
10445
|
focus: CallbackEventListener<'input'>;
|
|
9838
10446
|
}
|
|
9839
10447
|
|
|
10448
|
+
/**
|
|
10449
|
+
* The section component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10450
|
+
* @publicDocs
|
|
10451
|
+
*/
|
|
9840
10452
|
export interface SectionSlots {
|
|
9841
10453
|
/**
|
|
9842
10454
|
* The content displayed within the section component, which groups related elements together in a logical unit with an optional heading.
|
|
@@ -9844,6 +10456,10 @@ export interface SectionSlots {
|
|
|
9844
10456
|
children?: HTMLElement;
|
|
9845
10457
|
}
|
|
9846
10458
|
|
|
10459
|
+
/**
|
|
10460
|
+
* The select component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
10461
|
+
* @publicDocs
|
|
10462
|
+
*/
|
|
9847
10463
|
export interface SelectEvents {
|
|
9848
10464
|
/**
|
|
9849
10465
|
* A callback fired when the select value changes.
|
|
@@ -9859,6 +10475,10 @@ export interface SelectEvents {
|
|
|
9859
10475
|
input: CallbackEventListener<'input'>;
|
|
9860
10476
|
}
|
|
9861
10477
|
|
|
10478
|
+
/**
|
|
10479
|
+
* The select component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10480
|
+
* @publicDocs
|
|
10481
|
+
*/
|
|
9862
10482
|
export interface SelectSlots {
|
|
9863
10483
|
/**
|
|
9864
10484
|
* The selectable options displayed in the dropdown list. Accepts option components for individual selectable items, and option group components to organize related options into logical groups with labels.
|
|
@@ -9866,6 +10486,10 @@ export interface SelectSlots {
|
|
|
9866
10486
|
children?: HTMLElement;
|
|
9867
10487
|
}
|
|
9868
10488
|
|
|
10489
|
+
/**
|
|
10490
|
+
* The stack component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10491
|
+
* @publicDocs
|
|
10492
|
+
*/
|
|
9869
10493
|
export interface StackSlots {
|
|
9870
10494
|
/**
|
|
9871
10495
|
* The child elements displayed within the stack component, which are arranged vertically or horizontally with consistent spacing.
|
|
@@ -9873,6 +10497,10 @@ export interface StackSlots {
|
|
|
9873
10497
|
children?: HTMLElement;
|
|
9874
10498
|
}
|
|
9875
10499
|
|
|
10500
|
+
/**
|
|
10501
|
+
* The switch component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
10502
|
+
* @publicDocs
|
|
10503
|
+
*/
|
|
9876
10504
|
export interface SwitchEvents {
|
|
9877
10505
|
/**
|
|
9878
10506
|
* A callback fired when the switch value changes.
|
|
@@ -9888,6 +10516,10 @@ export interface SwitchEvents {
|
|
|
9888
10516
|
input: CallbackEventListener<'input'>;
|
|
9889
10517
|
}
|
|
9890
10518
|
|
|
10519
|
+
/**
|
|
10520
|
+
* The table component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
10521
|
+
* @publicDocs
|
|
10522
|
+
*/
|
|
9891
10523
|
export interface TableEvents {
|
|
9892
10524
|
/**
|
|
9893
10525
|
* A callback fired when the user navigates to the previous page.
|
|
@@ -9899,6 +10531,10 @@ export interface TableEvents {
|
|
|
9899
10531
|
nextpage: CallbackEventListener<typeof tagName> | null = null;
|
|
9900
10532
|
}
|
|
9901
10533
|
|
|
10534
|
+
/**
|
|
10535
|
+
* The table component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10536
|
+
* @publicDocs
|
|
10537
|
+
*/
|
|
9902
10538
|
export interface TableSlots {
|
|
9903
10539
|
/**
|
|
9904
10540
|
* The table structure defining headers and data rows.
|
|
@@ -9914,6 +10550,10 @@ export interface TableSlots {
|
|
|
9914
10550
|
filters?: HTMLElement;
|
|
9915
10551
|
}
|
|
9916
10552
|
|
|
10553
|
+
/**
|
|
10554
|
+
* The table body component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10555
|
+
* @publicDocs
|
|
10556
|
+
*/
|
|
9917
10557
|
export interface TableBodySlots {
|
|
9918
10558
|
/**
|
|
9919
10559
|
* The data rows displayed in the table body.
|
|
@@ -9923,6 +10563,10 @@ export interface TableBodySlots {
|
|
|
9923
10563
|
children?: HTMLElement;
|
|
9924
10564
|
}
|
|
9925
10565
|
|
|
10566
|
+
/**
|
|
10567
|
+
* The table cell component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10568
|
+
* @publicDocs
|
|
10569
|
+
*/
|
|
9926
10570
|
export interface TableCellSlots {
|
|
9927
10571
|
/**
|
|
9928
10572
|
* The data value displayed in this cell.
|
|
@@ -9932,6 +10576,10 @@ export interface TableCellSlots {
|
|
|
9932
10576
|
children?: HTMLElement;
|
|
9933
10577
|
}
|
|
9934
10578
|
|
|
10579
|
+
/**
|
|
10580
|
+
* The table header component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10581
|
+
* @publicDocs
|
|
10582
|
+
*/
|
|
9935
10583
|
export interface TableHeaderSlots {
|
|
9936
10584
|
/**
|
|
9937
10585
|
* The column heading text.
|
|
@@ -9941,6 +10589,10 @@ export interface TableHeaderSlots {
|
|
|
9941
10589
|
children?: HTMLElement;
|
|
9942
10590
|
}
|
|
9943
10591
|
|
|
10592
|
+
/**
|
|
10593
|
+
* The table header row component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10594
|
+
* @publicDocs
|
|
10595
|
+
*/
|
|
9944
10596
|
export interface TableHeaderRowSlots {
|
|
9945
10597
|
/**
|
|
9946
10598
|
* The column headers displayed in the table header row.
|
|
@@ -9950,6 +10602,10 @@ export interface TableHeaderRowSlots {
|
|
|
9950
10602
|
children?: HTMLElement;
|
|
9951
10603
|
}
|
|
9952
10604
|
|
|
10605
|
+
/**
|
|
10606
|
+
* The table row component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10607
|
+
* @publicDocs
|
|
10608
|
+
*/
|
|
9953
10609
|
export interface TableRowSlots {
|
|
9954
10610
|
/**
|
|
9955
10611
|
* The data cells displayed in this table row.
|
|
@@ -9959,6 +10615,10 @@ export interface TableRowSlots {
|
|
|
9959
10615
|
children?: HTMLElement;
|
|
9960
10616
|
}
|
|
9961
10617
|
|
|
10618
|
+
/**
|
|
10619
|
+
* The text component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10620
|
+
* @publicDocs
|
|
10621
|
+
*/
|
|
9962
10622
|
export interface TextSlots {
|
|
9963
10623
|
/**
|
|
9964
10624
|
* The text content displayed within the text component, which applies semantic meaning and styling appropriate to the specified text type.
|
|
@@ -9966,6 +10626,10 @@ export interface TextSlots {
|
|
|
9966
10626
|
children?: HTMLElement;
|
|
9967
10627
|
}
|
|
9968
10628
|
|
|
10629
|
+
/**
|
|
10630
|
+
* 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).
|
|
10631
|
+
* @publicDocs
|
|
10632
|
+
*/
|
|
9969
10633
|
export interface TextAreaEvents {
|
|
9970
10634
|
/**
|
|
9971
10635
|
* A callback fired when the text area value changes.
|
|
@@ -9993,6 +10657,10 @@ export interface TextAreaEvents {
|
|
|
9993
10657
|
focus: CallbackEventListener<'input'>;
|
|
9994
10658
|
}
|
|
9995
10659
|
|
|
10660
|
+
/**
|
|
10661
|
+
* 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).
|
|
10662
|
+
* @publicDocs
|
|
10663
|
+
*/
|
|
9996
10664
|
export interface TextFieldEvents {
|
|
9997
10665
|
/**
|
|
9998
10666
|
* A callback fired when the text field value changes.
|
|
@@ -10020,6 +10688,10 @@ export interface TextFieldEvents {
|
|
|
10020
10688
|
focus: CallbackEventListener<'input'>;
|
|
10021
10689
|
}
|
|
10022
10690
|
|
|
10691
|
+
/**
|
|
10692
|
+
* 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).
|
|
10693
|
+
* @publicDocs
|
|
10694
|
+
*/
|
|
10023
10695
|
export interface TextFieldSlots {
|
|
10024
10696
|
/**
|
|
10025
10697
|
* Additional interactive content displayed within the text field.
|
|
@@ -10029,6 +10701,10 @@ export interface TextFieldSlots {
|
|
|
10029
10701
|
accessory?: HTMLElement;
|
|
10030
10702
|
}
|
|
10031
10703
|
|
|
10704
|
+
/**
|
|
10705
|
+
* The thumbnail component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
10706
|
+
* @publicDocs
|
|
10707
|
+
*/
|
|
10032
10708
|
export interface ThumbnailEvents {
|
|
10033
10709
|
/**
|
|
10034
10710
|
* A callback fired when the thumbnail image successfully loads.
|
|
@@ -10044,6 +10720,10 @@ export interface ThumbnailEvents {
|
|
|
10044
10720
|
error: OnErrorEventHandler = null;
|
|
10045
10721
|
}
|
|
10046
10722
|
|
|
10723
|
+
/**
|
|
10724
|
+
* The tooltip component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10725
|
+
* @publicDocs
|
|
10726
|
+
*/
|
|
10047
10727
|
export interface TooltipSlots {
|
|
10048
10728
|
/**
|
|
10049
10729
|
* The informational text or elements displayed within the tooltip overlay, providing helpful context or explanations when users interact with the associated element.
|
|
@@ -10053,6 +10733,10 @@ export interface TooltipSlots {
|
|
|
10053
10733
|
children?: HTMLElement;
|
|
10054
10734
|
}
|
|
10055
10735
|
|
|
10736
|
+
/**
|
|
10737
|
+
* 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).
|
|
10738
|
+
* @publicDocs
|
|
10739
|
+
*/
|
|
10056
10740
|
export interface URLFieldEvents {
|
|
10057
10741
|
/**
|
|
10058
10742
|
* A callback fired when the URL field value changes.
|
|
@@ -10080,6 +10764,10 @@ export interface URLFieldEvents {
|
|
|
10080
10764
|
focus: CallbackEventListener<'input'>;
|
|
10081
10765
|
}
|
|
10082
10766
|
|
|
10767
|
+
/**
|
|
10768
|
+
* The unordered list component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10769
|
+
* @publicDocs
|
|
10770
|
+
*/
|
|
10083
10771
|
export interface UnorderedListSlots {
|
|
10084
10772
|
/**
|
|
10085
10773
|
* The list entries displayed within the unordered list, where each item is marked with a bullet point. Only accepts list item components as children. Each list item represents a single bulleted entry in the list.
|
|
@@ -10087,6 +10775,10 @@ export interface UnorderedListSlots {
|
|
|
10087
10775
|
children?: HTMLElement;
|
|
10088
10776
|
}
|
|
10089
10777
|
|
|
10778
|
+
/**
|
|
10779
|
+
* The admin action component supports slots for additional content placement within the component. Learn more about [using slots](/docs/api/polaris/using-polaris-web-components#slots).
|
|
10780
|
+
* @publicDocs
|
|
10781
|
+
*/
|
|
10090
10782
|
export interface AdminActionSlots {
|
|
10091
10783
|
/**
|
|
10092
10784
|
* The main action button or link displayed in the admin action modal.
|
|
@@ -10100,6 +10792,10 @@ export interface AdminActionSlots {
|
|
|
10100
10792
|
'secondary-actions': HTMLElement;
|
|
10101
10793
|
}
|
|
10102
10794
|
|
|
10795
|
+
/**
|
|
10796
|
+
* The form component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
10797
|
+
* @publicDocs
|
|
10798
|
+
*/
|
|
10103
10799
|
export interface FormEvents {
|
|
10104
10800
|
/**
|
|
10105
10801
|
* A callback that is run when the form is submitted.
|
|
@@ -10111,6 +10807,10 @@ export interface FormEvents {
|
|
|
10111
10807
|
reset: CallbackEventListener<typeof tagName> | null = null;
|
|
10112
10808
|
}
|
|
10113
10809
|
|
|
10810
|
+
/**
|
|
10811
|
+
* The function settings component provides event callbacks for handling user interactions. Learn more about [handling events](/docs/api/polaris/using-polaris-web-components#handling-events).
|
|
10812
|
+
* @publicDocs
|
|
10813
|
+
*/
|
|
10114
10814
|
export interface FunctionSettingsEvents {
|
|
10115
10815
|
/**
|
|
10116
10816
|
* An optional callback function that will be run by the admin when the user
|