@shopify/ui-extensions 2026.7.4 → 2026.10.0-rc.10
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/market.js +8 -2
- package/build/cjs/surfaces/checkout/shared.js +0 -2
- package/build/cjs/surfaces/customer-account/preact/market.js +8 -2
- package/build/cjs/surfaces/point-of-sale/events.js +129 -1
- package/build/cjs/surfaces/point-of-sale/types/storage.js +11 -0
- package/build/cjs/surfaces/point-of-sale.js +1 -0
- package/build/esm/surfaces/checkout/preact/market.mjs +8 -2
- package/build/esm/surfaces/checkout/shared.mjs +0 -2
- package/build/esm/surfaces/customer-account/preact/market.mjs +8 -2
- package/build/esm/surfaces/point-of-sale/events.mjs +129 -2
- package/build/esm/surfaces/point-of-sale/types/storage.mjs +11 -0
- package/build/esm/surfaces/point-of-sale.mjs +1 -1
- package/build/esnext/surfaces/checkout/preact/market.esnext +8 -2
- package/build/esnext/surfaces/checkout/shared.esnext +0 -2
- package/build/esnext/surfaces/customer-account/preact/market.esnext +8 -2
- package/build/esnext/surfaces/point-of-sale/events.esnext +129 -2
- package/build/esnext/surfaces/point-of-sale/types/storage.esnext +11 -0
- package/build/esnext/surfaces/point-of-sale.esnext +1 -1
- package/build/ts/shared.d.ts +2 -2
- package/build/ts/shared.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminAction.d.ts +61 -107
- package/build/ts/surfaces/admin/components/AdminBlock.d.ts +22 -107
- package/build/ts/surfaces/admin/components/AdminPrintAction.d.ts +20 -101
- package/build/ts/surfaces/admin/components/AppNav.d.ts +38 -1
- package/build/ts/surfaces/admin/components/Avatar.d.ts +100 -139
- package/build/ts/surfaces/admin/components/Badge.d.ts +107 -156
- package/build/ts/surfaces/admin/components/Banner.d.ts +102 -127
- package/build/ts/surfaces/admin/components/Box.d.ts +145 -234
- package/build/ts/surfaces/admin/components/Button.d.ts +156 -266
- package/build/ts/surfaces/admin/components/ButtonGroup.d.ts +89 -117
- package/build/ts/surfaces/admin/components/Checkbox.d.ts +139 -174
- package/build/ts/surfaces/admin/components/Chip.d.ts +117 -15
- package/build/ts/surfaces/admin/components/Choice.d.ts +88 -113
- package/build/ts/surfaces/admin/components/ChoiceList.d.ts +120 -129
- package/build/ts/surfaces/admin/components/Clickable.d.ts +227 -209
- package/build/ts/surfaces/admin/components/ClickableChip.d.ts +117 -153
- package/build/ts/surfaces/admin/components/ColorField.d.ts +111 -215
- package/build/ts/surfaces/admin/components/ColorPicker.d.ts +82 -137
- package/build/ts/surfaces/admin/components/DateField.d.ts +140 -230
- package/build/ts/surfaces/admin/components/DatePicker.d.ts +178 -181
- package/build/ts/surfaces/admin/components/Divider.d.ts +50 -118
- package/build/ts/surfaces/admin/components/DropZone.d.ts +153 -12
- package/build/ts/surfaces/admin/components/EmailField.d.ts +100 -197
- package/build/ts/surfaces/admin/components/EmptyState.d.ts +144 -0
- package/build/ts/surfaces/admin/components/Form.d.ts +25 -118
- package/build/ts/surfaces/admin/components/FunctionSettings.d.ts +26 -132
- package/build/ts/surfaces/admin/components/Grid.d.ts +165 -299
- package/build/ts/surfaces/admin/components/GridItem.d.ts +145 -261
- package/build/ts/surfaces/admin/components/Heading.d.ts +117 -117
- package/build/ts/surfaces/admin/components/Icon.d.ts +91 -129
- package/build/ts/surfaces/admin/components/Image.d.ts +216 -251
- package/build/ts/surfaces/admin/components/Link.d.ts +125 -126
- package/build/ts/surfaces/admin/components/ListItem.d.ts +63 -102
- package/build/ts/surfaces/admin/components/Menu.d.ts +82 -150
- package/build/ts/surfaces/admin/components/Modal.d.ts +232 -26
- package/build/ts/surfaces/admin/components/MoneyField.d.ts +103 -196
- package/build/ts/surfaces/admin/components/Number.d.ts +193 -0
- package/build/ts/surfaces/admin/components/NumberField.d.ts +114 -208
- package/build/ts/surfaces/admin/components/Option.d.ts +67 -108
- package/build/ts/surfaces/admin/components/OptionGroup.d.ts +69 -105
- package/build/ts/surfaces/admin/components/OrderedList.d.ts +56 -102
- package/build/ts/surfaces/admin/components/Page.d.ts +93 -13
- package/build/ts/surfaces/admin/components/Paragraph.d.ts +126 -138
- package/build/ts/surfaces/admin/components/PasswordField.d.ts +109 -203
- package/build/ts/surfaces/admin/components/Popover.d.ts +673 -0
- package/build/ts/surfaces/admin/components/Progress.d.ts +155 -0
- package/build/ts/surfaces/admin/components/QueryContainer.d.ts +77 -116
- package/build/ts/surfaces/admin/components/SearchField.d.ts +103 -191
- package/build/ts/surfaces/admin/components/Section.d.ts +132 -128
- package/build/ts/surfaces/admin/components/Select.d.ts +144 -193
- package/build/ts/surfaces/admin/components/Spinner.d.ts +60 -113
- package/build/ts/surfaces/admin/components/Stack.d.ts +156 -282
- package/build/ts/surfaces/admin/components/StandardComponents.d.ts +1 -1
- package/build/ts/surfaces/admin/components/StandardComponents.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/Switch.d.ts +75 -165
- package/build/ts/surfaces/admin/components/Table.d.ts +100 -210
- package/build/ts/surfaces/admin/components/TableBody.d.ts +70 -106
- package/build/ts/surfaces/admin/components/TableCell.d.ts +70 -107
- package/build/ts/surfaces/admin/components/TableHeader.d.ts +79 -119
- package/build/ts/surfaces/admin/components/TableHeaderRow.d.ts +71 -107
- package/build/ts/surfaces/admin/components/TableRow.d.ts +81 -109
- package/build/ts/surfaces/admin/components/Text.d.ts +123 -164
- package/build/ts/surfaces/admin/components/TextArea.d.ts +100 -195
- package/build/ts/surfaces/admin/components/TextField.d.ts +120 -204
- package/build/ts/surfaces/admin/components/Thumbnail.d.ts +83 -133
- package/build/ts/surfaces/admin/components/Tooltip.d.ts +78 -146
- package/build/ts/surfaces/admin/components/URLField.d.ts +107 -209
- package/build/ts/surfaces/admin/components/UnorderedList.d.ts +58 -110
- package/build/ts/surfaces/admin/components/shared.d.ts +4193 -1203
- package/build/ts/surfaces/admin/extension-targets.d.ts +8 -0
- package/build/ts/surfaces/admin/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/admin/targets/admin.abandoned-checkout-details.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.abandoned-checkout-details.block.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.abandoned-checkout-index.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.app.home.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.app.intent.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.catalog-details.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.catalog-details.block.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.collection-details.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.collection-details.block.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.collection-index.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.company-details.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.company-details.block.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.company-location-details.block.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.customer-details.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.customer-details.block.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.customer-index.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.customer-index.selection-action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.customer-segment-details.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.discount-details.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.discount-details.function-settings.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.discount-index.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.discount-index.selection-action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.draft-order-details.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.draft-order-details.block.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.draft-order-index.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.draft-order-index.selection-action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.gift-card-details.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.gift-card-details.block.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.order-details.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.order-details.block.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.order-details.print-action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.order-fulfilled-card.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.order-index.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.order-index.selection-action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.order-index.selection-print-action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-details.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-details.block.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-details.configuration.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-details.configuration.should-render.d.ts +6 -0
- package/build/ts/surfaces/admin/targets/admin.product-details.print-action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-details.reorder.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-index.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-index.selection-action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-index.selection-print-action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-purchase-option.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-variant-details.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-variant-details.block.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-variant-details.configuration.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.product-variant-details.configuration.should-render.d.ts +6 -0
- package/build/ts/surfaces/admin/targets/admin.product-variant-purchase-option.action.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.settings.internal-order-routing-rule.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.settings.order-routing-rule.render.d.ts +2 -0
- package/build/ts/surfaces/admin/targets/admin.settings.validation.render.d.ts +2 -0
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts +8 -5
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Box.d.ts +56 -1
- package/build/ts/surfaces/checkout/components/components-shared.d.ts +1 -1
- package/build/ts/surfaces/checkout/preact/market.d.ts +8 -2
- package/build/ts/surfaces/checkout/preact/market.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/shared.d.ts +1 -3
- package/build/ts/surfaces/checkout/shared.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/targets/purchase.cart-line-item.line-components.render.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.actions.render-before.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.block.render.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-item.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-list.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.contact.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-before.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.footer.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.gift-card.render.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.header.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-before.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.action-required.render.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.details.render.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.hosted-fields.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-before.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-option-item.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-before.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-before.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.details.render.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-before.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.block.render.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-item.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-list.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.customer-information.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.footer.render-after.d.ts +0 -1
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.header.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts +6 -1
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/Box.d.ts +56 -1
- package/build/ts/surfaces/customer-account/components/components-shared.d.ts +1 -1
- package/build/ts/surfaces/customer-account/preact/market.d.ts +8 -2
- package/build/ts/surfaces/customer-account/preact/market.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.footer.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order-index.announcement.render.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order-index.block.render.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.announcement.render.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.block.render.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-item.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-list.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.customer-information.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.fulfillment-details.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.payment-details.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.return-details.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.unfulfilled-items.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order.action.menu-item.render.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order.action.render.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.order.page.render.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.page.render.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.addresses.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.announcement.render.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.block.render.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-details.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-addresses.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-payment.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-staff.render-after.d.ts +0 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.payment.render-after.d.ts +0 -1
- package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts +13 -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/resolution-api/resolution-api.d.ts +23 -0
- package/build/ts/surfaces/point-of-sale/api/resolution-api/resolution-api.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/api.d.ts +3 -2
- package/build/ts/surfaces/point-of-sale/api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/ResolutionComponents.d.ts +10 -0
- package/build/ts/surfaces/point-of-sale/components/targets/ResolutionComponents.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/events/scan-event.d.ts +34 -0
- package/build/ts/surfaces/point-of-sale/events/scan-event.d.ts.map +1 -0
- package/build/ts/surfaces/point-of-sale/events.d.ts +183 -1
- package/build/ts/surfaces/point-of-sale/events.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +17 -3
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/globals.d.ts +8 -1
- package/build/ts/surfaces/point-of-sale/globals.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/targets/pos.cart.validations.resolution.render.d.ts +44 -0
- package/build/ts/surfaces/point-of-sale/targets/pos.payment.validations.resolution.render.d.ts +44 -0
- package/build/ts/surfaces/point-of-sale/types/cart.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/storage.d.ts +40 -0
- package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/src/shared.ts +4 -2
- package/src/surfaces/admin/components/AdminAction.d.ts +61 -107
- package/src/surfaces/admin/components/AdminBlock.d.ts +22 -107
- package/src/surfaces/admin/components/AdminPrintAction.d.ts +20 -101
- package/src/surfaces/admin/components/AppNav.d.ts +38 -1
- package/src/surfaces/admin/components/Avatar.d.ts +100 -139
- package/src/surfaces/admin/components/Badge.d.ts +107 -156
- package/src/surfaces/admin/components/Banner.d.ts +102 -127
- package/src/surfaces/admin/components/Box.d.ts +145 -234
- package/src/surfaces/admin/components/Button.d.ts +156 -266
- package/src/surfaces/admin/components/ButtonGroup.d.ts +89 -117
- package/src/surfaces/admin/components/Checkbox.d.ts +139 -174
- package/src/surfaces/admin/components/Chip.d.ts +117 -15
- package/src/surfaces/admin/components/Choice.d.ts +88 -113
- package/src/surfaces/admin/components/ChoiceList.d.ts +120 -129
- package/src/surfaces/admin/components/Clickable.d.ts +227 -209
- package/src/surfaces/admin/components/ClickableChip.d.ts +117 -153
- package/src/surfaces/admin/components/ColorField.d.ts +111 -215
- package/src/surfaces/admin/components/ColorPicker.d.ts +82 -137
- package/src/surfaces/admin/components/DateField.d.ts +140 -230
- package/src/surfaces/admin/components/DatePicker.d.ts +178 -181
- package/src/surfaces/admin/components/Divider.d.ts +50 -118
- package/src/surfaces/admin/components/DropZone.d.ts +153 -12
- package/src/surfaces/admin/components/EmailField.d.ts +100 -197
- package/src/surfaces/admin/components/EmptyState.d.ts +144 -0
- package/src/surfaces/admin/components/Form.d.ts +25 -118
- package/src/surfaces/admin/components/FunctionSettings.d.ts +26 -132
- package/src/surfaces/admin/components/Grid.d.ts +165 -299
- package/src/surfaces/admin/components/GridItem.d.ts +145 -261
- package/src/surfaces/admin/components/Heading.d.ts +117 -117
- package/src/surfaces/admin/components/Icon.d.ts +91 -129
- package/src/surfaces/admin/components/Image.d.ts +216 -251
- package/src/surfaces/admin/components/Link.d.ts +125 -126
- package/src/surfaces/admin/components/ListItem.d.ts +63 -102
- package/src/surfaces/admin/components/Menu.d.ts +82 -150
- package/src/surfaces/admin/components/Modal.d.ts +232 -26
- package/src/surfaces/admin/components/MoneyField.d.ts +103 -196
- package/src/surfaces/admin/components/Number.d.ts +193 -0
- package/src/surfaces/admin/components/NumberField.d.ts +114 -208
- package/src/surfaces/admin/components/Option.d.ts +67 -108
- package/src/surfaces/admin/components/OptionGroup.d.ts +69 -105
- package/src/surfaces/admin/components/OrderedList.d.ts +56 -102
- package/src/surfaces/admin/components/Page.d.ts +93 -13
- package/src/surfaces/admin/components/Paragraph.d.ts +126 -138
- package/src/surfaces/admin/components/PasswordField.d.ts +109 -203
- package/src/surfaces/admin/components/Popover.d.ts +673 -0
- package/src/surfaces/admin/components/Progress.d.ts +155 -0
- package/src/surfaces/admin/components/QueryContainer.d.ts +77 -116
- package/src/surfaces/admin/components/SearchField.d.ts +103 -191
- package/src/surfaces/admin/components/Section.d.ts +132 -128
- package/src/surfaces/admin/components/Select.d.ts +144 -193
- package/src/surfaces/admin/components/Spinner.d.ts +60 -113
- package/src/surfaces/admin/components/Stack.d.ts +156 -282
- package/src/surfaces/admin/components/StandardComponents.ts +2 -0
- package/src/surfaces/admin/components/Switch.d.ts +75 -165
- package/src/surfaces/admin/components/Table.d.ts +100 -210
- package/src/surfaces/admin/components/TableBody.d.ts +70 -106
- package/src/surfaces/admin/components/TableCell.d.ts +70 -107
- package/src/surfaces/admin/components/TableHeader.d.ts +79 -119
- package/src/surfaces/admin/components/TableHeaderRow.d.ts +71 -107
- package/src/surfaces/admin/components/TableRow.d.ts +81 -109
- package/src/surfaces/admin/components/Text.d.ts +123 -164
- package/src/surfaces/admin/components/TextArea.d.ts +100 -195
- package/src/surfaces/admin/components/TextField.d.ts +120 -204
- package/src/surfaces/admin/components/Thumbnail.d.ts +83 -133
- package/src/surfaces/admin/components/Tooltip.d.ts +78 -146
- package/src/surfaces/admin/components/URLField.d.ts +107 -209
- package/src/surfaces/admin/components/UnorderedList.d.ts +58 -110
- package/src/surfaces/admin/components/shared.d.ts +4193 -1203
- package/src/surfaces/admin/extension-targets.ts +18 -0
- package/src/surfaces/checkout/api/standard/standard.ts +8 -5
- package/src/surfaces/checkout/components/Box.d.ts +56 -1
- package/src/surfaces/checkout/components/components-shared.d.ts +1 -1
- package/src/surfaces/checkout/preact/market.ts +8 -2
- package/src/surfaces/checkout/shared.ts +1 -6
- package/src/surfaces/customer-account/api/order-status/order-status.ts +6 -1
- package/src/surfaces/customer-account/preact/market.ts +8 -2
- package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +14 -0
- package/src/surfaces/point-of-sale/api/resolution-api/resolution-api.ts +24 -0
- package/src/surfaces/point-of-sale/api.ts +7 -1
- package/src/surfaces/point-of-sale/components/targets/ResolutionComponents.ts +13 -0
- package/src/surfaces/point-of-sale/events/scan-event.ts +34 -0
- package/src/surfaces/point-of-sale/events.ts +215 -0
- package/src/surfaces/point-of-sale/extension-targets.ts +33 -2
- package/src/surfaces/point-of-sale/globals.ts +16 -1
- package/src/surfaces/point-of-sale/types/cart.ts +4 -0
- package/src/surfaces/point-of-sale/types/storage.ts +47 -0
- package/build/ts/surfaces/checkout/components/LoginWithShop.d.ts +0 -164
- package/build/ts/surfaces/customer-account/components/LoginWithShop.d.ts +0 -164
- package/src/surfaces/checkout/components/LoginWithShop.d.ts +0 -164
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/** VERSION:
|
|
1
|
+
/** VERSION: 2.23.0 **/
|
|
2
2
|
/* eslint-disable import/extensions */
|
|
3
3
|
|
|
4
4
|
/* eslint-disable @typescript-eslint/no-namespace */
|
|
@@ -15,43 +15,106 @@ import type {
|
|
|
15
15
|
SizeUnits,
|
|
16
16
|
SizeUnitsOrNone,
|
|
17
17
|
InteractionProps,
|
|
18
|
+
PreactCustomElement,
|
|
19
|
+
RenderImpl,
|
|
18
20
|
} from './shared.d.ts';
|
|
21
|
+
import * as preact$1 from 'preact';
|
|
22
|
+
import {ReactNode, RefAttributes} from 'react';
|
|
23
|
+
import * as _shopify_admin_web_component_foundations from '@shopify/admin-web-component-foundations';
|
|
19
24
|
|
|
25
|
+
/**
|
|
26
|
+
* An event object with a strongly-typed `currentTarget` property that references the specific HTML element that triggered the event.
|
|
27
|
+
*
|
|
28
|
+
* This type extends the standard DOM `Event` interface and ensures type safety when accessing the element that fired the event.
|
|
29
|
+
* @publicDocs
|
|
30
|
+
*/
|
|
20
31
|
export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
|
|
21
32
|
currentTarget: HTMLElementTagNameMap[T];
|
|
22
33
|
};
|
|
34
|
+
/**
|
|
35
|
+
* A function that handles events from UI components.
|
|
36
|
+
*
|
|
37
|
+
* This type represents an event listener callback that receives a `CallbackEvent` with a strongly-typed `currentTarget`. Use this for component event handlers like `click`, `focus`, `blur`, and other DOM events.
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* const handleClick: CallbackEventListener<'button'> = (event) => {
|
|
41
|
+
* console.log('Button clicked:', event.currentTarget);
|
|
42
|
+
* };
|
|
43
|
+
* @publicDocs
|
|
44
|
+
*/
|
|
23
45
|
export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
|
|
24
46
|
| (EventListener & {
|
|
25
47
|
(event: CallbackEvent<T>): void;
|
|
26
48
|
})
|
|
27
49
|
| null;
|
|
28
50
|
/**
|
|
29
|
-
*
|
|
51
|
+
* Base props for Preact custom elements without children support. Includes common properties like key, ref, and slot for elements that don't accept child content.
|
|
30
52
|
* @publicDocs
|
|
31
53
|
*/
|
|
32
54
|
export interface PreactBaseElementProps<TClass extends HTMLElement> {
|
|
33
55
|
/**
|
|
34
|
-
* A unique identifier for this element
|
|
56
|
+
* A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists.
|
|
57
|
+
* Essential for maintaining component state and optimizing re-renders when lists change.
|
|
35
58
|
*/
|
|
36
59
|
key?: preact.Key;
|
|
37
60
|
/**
|
|
38
|
-
* A reference to the underlying DOM element
|
|
61
|
+
* A reference to access the underlying DOM element directly.
|
|
62
|
+
* Typically created using `useRef()` to interact with the element imperatively or measure its properties.
|
|
39
63
|
*/
|
|
40
64
|
ref?: preact.Ref<TClass>;
|
|
41
65
|
/**
|
|
42
|
-
*
|
|
66
|
+
* The named slot to which this element is assigned in the parent component's shadow DOM.
|
|
67
|
+
*
|
|
68
|
+
* Used for advanced component composition with web components.
|
|
43
69
|
*/
|
|
44
70
|
slot?: Lowercase<string>;
|
|
45
71
|
}
|
|
46
72
|
/**
|
|
47
|
-
*
|
|
73
|
+
* Base props for Preact custom elements with children support. Extends PreactBaseElementProps with the ability to render child elements.
|
|
48
74
|
* @publicDocs
|
|
49
75
|
*/
|
|
50
76
|
export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
|
|
51
77
|
extends PreactBaseElementProps<TClass> {
|
|
78
|
+
/**
|
|
79
|
+
* The child elements to be rendered within this component.
|
|
80
|
+
*/
|
|
52
81
|
children?: preact.ComponentChildren;
|
|
53
82
|
}
|
|
54
|
-
|
|
83
|
+
|
|
84
|
+
export type ReactIntrinsicElementChildren<PreactProps extends object> =
|
|
85
|
+
'children' extends keyof PreactProps
|
|
86
|
+
? {
|
|
87
|
+
children?: ReactNode;
|
|
88
|
+
}
|
|
89
|
+
: Record<never, never>;
|
|
90
|
+
export type ReactIntrinsicElementProps<
|
|
91
|
+
PreactProps extends object,
|
|
92
|
+
ElementType,
|
|
93
|
+
> = Omit<PreactProps, 'children' | 'key' | 'ref' | 'slot'> &
|
|
94
|
+
ReactIntrinsicElementChildren<PreactProps> &
|
|
95
|
+
RefAttributes<ElementType> & {
|
|
96
|
+
slot?: Lowercase<string>;
|
|
97
|
+
};
|
|
98
|
+
export type ReactIntrinsicElements = {
|
|
99
|
+
[Tag in Exclude<
|
|
100
|
+
Extract<keyof preact$1.createElement.JSX.IntrinsicElements, `s-${string}`>,
|
|
101
|
+
`s-test-${string}`
|
|
102
|
+
>]: ReactIntrinsicElementProps<
|
|
103
|
+
preact$1.createElement.JSX.IntrinsicElements[Tag],
|
|
104
|
+
Tag extends keyof HTMLElementTagNameMap
|
|
105
|
+
? HTMLElementTagNameMap[Tag]
|
|
106
|
+
: HTMLElement
|
|
107
|
+
>;
|
|
108
|
+
};
|
|
109
|
+
declare module 'react' {
|
|
110
|
+
namespace JSX {
|
|
111
|
+
interface IntrinsicElements extends ReactIntrinsicElements {}
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* Makes a type responsive by allowing it to be either the base value or a container query string. This enables conditional styling based on container dimensions.
|
|
117
|
+
* @publicDocs
|
|
55
118
|
*/
|
|
56
119
|
export type MakeResponsive<T> = T | `@container${string}`;
|
|
57
120
|
/**
|
|
@@ -75,7 +138,24 @@ export type MakeResponsivePick<TType, TProperty extends keyof TType> = {
|
|
|
75
138
|
[P in TProperty]: MakeResponsive<TType[P]>;
|
|
76
139
|
};
|
|
77
140
|
|
|
141
|
+
/**
|
|
142
|
+
* Represents the box component props with all properties marked as required.
|
|
143
|
+
* @publicDocs
|
|
144
|
+
*/
|
|
78
145
|
export type RequiredBoxProps = Required<BoxProps$1>;
|
|
146
|
+
/**
|
|
147
|
+
* Represents the subset of border radius values supported by the component.
|
|
148
|
+
*
|
|
149
|
+
* - `small-200`: Extra small radius for subtle rounding.
|
|
150
|
+
* - `small-100`: Small radius for minimal corner rounding.
|
|
151
|
+
* - `small`: Standard small radius.
|
|
152
|
+
* - `base`: Medium radius for moderate corner rounding.
|
|
153
|
+
* - `large`: Standard large radius for pronounced rounding.
|
|
154
|
+
* - `large-100`: Large radius for more prominent corner rounding.
|
|
155
|
+
* - `large-200`: Extra large radius for maximum rounding.
|
|
156
|
+
* - `none`: No border radius (sharp corners).
|
|
157
|
+
* @publicDocs
|
|
158
|
+
*/
|
|
79
159
|
export type BoxBorderRadii = Extract<
|
|
80
160
|
RequiredBoxProps['borderRadius'],
|
|
81
161
|
| 'none'
|
|
@@ -87,10 +167,25 @@ export type BoxBorderRadii = Extract<
|
|
|
87
167
|
| 'large-100'
|
|
88
168
|
| 'large-200'
|
|
89
169
|
>;
|
|
170
|
+
/**
|
|
171
|
+
* Represents the subset of border style values supported by the box component.
|
|
172
|
+
*
|
|
173
|
+
* - `auto`: Default border style determined by the system.
|
|
174
|
+
* - `none`: No border style (removes the border).
|
|
175
|
+
* - `solid`: Continuous line border.
|
|
176
|
+
* - `dashed`: Border made up of dashes.
|
|
177
|
+
* @publicDocs
|
|
178
|
+
*/
|
|
90
179
|
export type BoxBorderStyles = Extract<
|
|
91
180
|
RequiredBoxProps['borderStyle'],
|
|
92
181
|
'none' | 'solid' | 'dashed' | 'auto'
|
|
93
182
|
>;
|
|
183
|
+
/**
|
|
184
|
+
* Represents box props with responsive capabilities for layout properties.
|
|
185
|
+
*
|
|
186
|
+
* This enables conditional styling based on container queries.
|
|
187
|
+
* @publicDocs
|
|
188
|
+
*/
|
|
94
189
|
export type ResponsiveBoxProps = MakeResponsivePick<
|
|
95
190
|
RequiredBoxProps,
|
|
96
191
|
| 'padding'
|
|
@@ -123,7 +218,7 @@ export interface BoxProps
|
|
|
123
218
|
| 'overflow'
|
|
124
219
|
> {
|
|
125
220
|
/**
|
|
126
|
-
* The background color of the
|
|
221
|
+
* The background color of the component.
|
|
127
222
|
*
|
|
128
223
|
* @default 'transparent'
|
|
129
224
|
*/
|
|
@@ -132,16 +227,13 @@ export interface BoxProps
|
|
|
132
227
|
'transparent' | 'base' | 'subdued' | 'strong'
|
|
133
228
|
>;
|
|
134
229
|
/**
|
|
135
|
-
*
|
|
230
|
+
* A border applied using shorthand syntax to specify width, color, and style in a single property.
|
|
136
231
|
*
|
|
137
|
-
*
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
*
|
|
142
|
-
* - `none`: No border.
|
|
143
|
-
*
|
|
144
|
-
* Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different widths per side.
|
|
232
|
+
* @default 'none'
|
|
233
|
+
*/
|
|
234
|
+
border: RequiredBoxProps['border'];
|
|
235
|
+
/**
|
|
236
|
+
* The thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.
|
|
145
237
|
*
|
|
146
238
|
* @default '' - meaning no override
|
|
147
239
|
*/
|
|
@@ -154,10 +246,7 @@ export interface BoxProps
|
|
|
154
246
|
>
|
|
155
247
|
| Extract<RequiredBoxProps['borderWidth'], ''>;
|
|
156
248
|
/**
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
* When set, this overrides the style value specified in the `border` property.
|
|
160
|
-
* Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different styles per side.
|
|
249
|
+
* The visual style of the border on all sides, such as solid, dashed, or dotted. When set, this overrides the style value specified in the `border` property.
|
|
161
250
|
*
|
|
162
251
|
* @default '' - meaning no override
|
|
163
252
|
*/
|
|
@@ -165,10 +254,7 @@ export interface BoxProps
|
|
|
165
254
|
| MaybeAllValuesShorthandProperty<BoxBorderStyles>
|
|
166
255
|
| Extract<RequiredBoxProps['borderStyle'], ''>;
|
|
167
256
|
/**
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
* When set, this overrides the color value specified in the `border` property.
|
|
171
|
-
* Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.
|
|
257
|
+
* The color of the border using the design system's color scale. When set, this overrides the color value specified in the `border` property.
|
|
172
258
|
*
|
|
173
259
|
* @default '' - meaning no override
|
|
174
260
|
*/
|
|
@@ -177,101 +263,85 @@ export interface BoxProps
|
|
|
177
263
|
'subdued' | 'base' | 'strong' | ''
|
|
178
264
|
>;
|
|
179
265
|
/**
|
|
180
|
-
*
|
|
181
|
-
*
|
|
182
|
-
* Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) for specifying different radii per corner. Use this to create rounded or pill-shaped clickable elements.
|
|
266
|
+
* The roundedness of the element's corners using the design system's radius scale.
|
|
183
267
|
*
|
|
184
268
|
* @default 'none'
|
|
185
269
|
*/
|
|
186
270
|
borderRadius: MaybeAllValuesShorthandProperty<BoxBorderRadii>;
|
|
187
271
|
/**
|
|
188
|
-
* The padding applied to all edges of the
|
|
189
|
-
*
|
|
190
|
-
* [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is:
|
|
272
|
+
* The padding applied to all edges of the component.
|
|
191
273
|
*
|
|
192
|
-
* -
|
|
193
|
-
* -
|
|
194
|
-
* - 2 values
|
|
274
|
+
* Supports [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) using flow-relative values:
|
|
275
|
+
* - 1 value applies to all sides
|
|
276
|
+
* - 2 values apply to block (top/bottom) and inline (left/right)
|
|
277
|
+
* - 3 values apply to block-start (top), inline (left/right), and block-end (bottom)
|
|
278
|
+
* - 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)
|
|
195
279
|
*
|
|
196
|
-
*
|
|
197
|
-
* - `large` means block-start, inline-end, block-end and inline-start paddings are `large`.
|
|
198
|
-
* - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.
|
|
199
|
-
* - `large none large` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `none`.
|
|
200
|
-
* - `large none large small` means block-start padding is `large`, inline-end padding is `none`, block-end padding is `large` and inline-start padding is `small`.
|
|
280
|
+
* **Examples:** `base`, `large none`, `base large-100 base small`
|
|
201
281
|
*
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
* `padding` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
282
|
+
* Use `auto` to inherit padding from the nearest container with removed padding. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
205
283
|
*
|
|
206
284
|
* @default 'none'
|
|
207
285
|
*/
|
|
208
286
|
padding: ResponsiveBoxProps['padding'];
|
|
209
287
|
/**
|
|
210
|
-
* The
|
|
288
|
+
* The block-direction padding (top and bottom in horizontal writing modes).
|
|
211
289
|
*
|
|
212
|
-
* -
|
|
290
|
+
* Accepts a single value for both sides or two space-separated values for block-start and block-end.
|
|
213
291
|
*
|
|
214
|
-
*
|
|
292
|
+
* **Example:** `large none` applies `large` to the top and `none` to the bottom.
|
|
215
293
|
*
|
|
216
|
-
* `
|
|
294
|
+
* Overrides the block value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
217
295
|
*
|
|
218
296
|
* @default '' - meaning no override
|
|
219
297
|
*/
|
|
220
298
|
paddingBlock: ResponsiveBoxProps['paddingBlock'];
|
|
221
299
|
/**
|
|
222
|
-
* The
|
|
223
|
-
*
|
|
224
|
-
* This overrides the block-start value of `paddingBlock`.
|
|
300
|
+
* The block-start padding (top in horizontal writing modes).
|
|
225
301
|
*
|
|
226
|
-
* `
|
|
302
|
+
* Overrides the block-start value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
227
303
|
*
|
|
228
304
|
* @default '' - meaning no override
|
|
229
305
|
*/
|
|
230
306
|
paddingBlockStart: ResponsiveBoxProps['paddingBlockStart'];
|
|
231
307
|
/**
|
|
232
|
-
* The
|
|
308
|
+
* The block-end padding (bottom in horizontal writing modes).
|
|
233
309
|
*
|
|
234
|
-
*
|
|
235
|
-
*
|
|
236
|
-
* `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
310
|
+
* Overrides the block-end value from `paddingBlock`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
237
311
|
*
|
|
238
312
|
* @default '' - meaning no override
|
|
239
313
|
*/
|
|
240
314
|
paddingBlockEnd: ResponsiveBoxProps['paddingBlockEnd'];
|
|
241
315
|
/**
|
|
242
|
-
* The
|
|
316
|
+
* The inline-direction padding (left and right in horizontal writing modes).
|
|
243
317
|
*
|
|
244
|
-
* -
|
|
318
|
+
* Accepts a single value for both sides or two space-separated values for inline-start and inline-end.
|
|
245
319
|
*
|
|
246
|
-
*
|
|
320
|
+
* **Example:** `large none` applies `large` to the left and `none` to the right.
|
|
247
321
|
*
|
|
248
|
-
* `
|
|
322
|
+
* Overrides the inline value from `padding`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
249
323
|
*
|
|
250
324
|
* @default '' - meaning no override
|
|
251
325
|
*/
|
|
252
326
|
paddingInline: ResponsiveBoxProps['paddingInline'];
|
|
253
327
|
/**
|
|
254
|
-
* The
|
|
255
|
-
*
|
|
256
|
-
* This overrides the inline-start value of `paddingInline`.
|
|
328
|
+
* The inline-start padding (left in LTR writing modes, right in RTL).
|
|
257
329
|
*
|
|
258
|
-
* `
|
|
330
|
+
* Overrides the inline-start value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
259
331
|
*
|
|
260
332
|
* @default '' - meaning no override
|
|
261
333
|
*/
|
|
262
334
|
paddingInlineStart: ResponsiveBoxProps['paddingInlineStart'];
|
|
263
335
|
/**
|
|
264
|
-
* The
|
|
336
|
+
* The inline-end padding (right in LTR writing modes, left in RTL).
|
|
265
337
|
*
|
|
266
|
-
*
|
|
267
|
-
*
|
|
268
|
-
* `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
338
|
+
* Overrides the inline-end value from `paddingInline`. Also accepts a [responsive value](/docs/api/polaris/using-polaris-web-components#responsive-values) string with the supported `PaddingKeyword` as a query value.
|
|
269
339
|
*
|
|
270
340
|
* @default '' - meaning no override
|
|
271
341
|
*/
|
|
272
342
|
paddingInlineEnd: ResponsiveBoxProps['paddingInlineEnd'];
|
|
273
343
|
/**
|
|
274
|
-
*
|
|
344
|
+
* The outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/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).
|
|
275
345
|
*
|
|
276
346
|
* - `auto` the component's initial value. The actual value depends on the component and context.
|
|
277
347
|
* - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.
|
|
@@ -280,7 +350,7 @@ export interface BoxProps
|
|
|
280
350
|
*/
|
|
281
351
|
display: ResponsiveBoxProps['display'];
|
|
282
352
|
/**
|
|
283
|
-
* The vertical size of the
|
|
353
|
+
* The vertical size of the element in standard layouts (height in left-to-right or right-to-left writing modes).
|
|
284
354
|
*
|
|
285
355
|
* Block size adjusts based on the writing direction: in horizontal layouts, it controls the height;
|
|
286
356
|
* in vertical layouts, it controls the width. This ensures consistent behavior across different text directions.
|
|
@@ -291,37 +361,53 @@ export interface BoxProps
|
|
|
291
361
|
*/
|
|
292
362
|
blockSize: SizeUnitsOrAuto;
|
|
293
363
|
/**
|
|
294
|
-
* The
|
|
364
|
+
* The minimum height in horizontal writing modes, or minimum width in vertical writing modes.
|
|
365
|
+
* Prevents the element from shrinking below this size.
|
|
366
|
+
*
|
|
367
|
+
* Learn more about [min-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).
|
|
295
368
|
*
|
|
296
369
|
* @default '0'
|
|
297
370
|
*/
|
|
298
371
|
minBlockSize: SizeUnits;
|
|
299
372
|
/**
|
|
300
|
-
* The
|
|
373
|
+
* The maximum height in horizontal writing modes, or maximum width in vertical writing modes.
|
|
374
|
+
* Prevents the element from growing beyond this size.
|
|
375
|
+
*
|
|
376
|
+
* Learn more about [max-block-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).
|
|
301
377
|
*
|
|
302
378
|
* @default 'none'
|
|
303
379
|
*/
|
|
304
380
|
maxBlockSize: SizeUnitsOrNone;
|
|
305
381
|
/**
|
|
306
|
-
* The
|
|
382
|
+
* The width in horizontal writing modes, or height in vertical writing modes.
|
|
383
|
+
* Use this for flow-relative sizing that adapts to text direction. Learn more about [inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).
|
|
307
384
|
*
|
|
308
385
|
* @default 'auto'
|
|
309
386
|
*/
|
|
310
387
|
inlineSize: SizeUnitsOrAuto;
|
|
311
388
|
/**
|
|
312
|
-
* The
|
|
389
|
+
* The minimum width in horizontal writing modes, or minimum height in vertical writing modes.
|
|
390
|
+
* Prevents the element from shrinking below this size.
|
|
391
|
+
*
|
|
392
|
+
* Learn more about [min-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).
|
|
313
393
|
*
|
|
314
394
|
* @default '0'
|
|
315
395
|
*/
|
|
316
396
|
minInlineSize: SizeUnits;
|
|
317
397
|
/**
|
|
318
|
-
* The
|
|
398
|
+
* The maximum width in horizontal writing modes, or maximum height in vertical writing modes.
|
|
399
|
+
* Prevents the element from growing beyond this size.
|
|
400
|
+
*
|
|
401
|
+
* Learn more about [max-inline-size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).
|
|
319
402
|
*
|
|
320
403
|
* @default 'none'
|
|
321
404
|
*/
|
|
322
405
|
maxInlineSize: SizeUnitsOrNone;
|
|
323
406
|
}
|
|
324
|
-
|
|
407
|
+
|
|
408
|
+
/**
|
|
409
|
+
* Represents the base clickable props with all properties marked as required.
|
|
410
|
+
* @publicDocs
|
|
325
411
|
*/
|
|
326
412
|
export type ClickableBaseProps = Required<
|
|
327
413
|
Pick<
|
|
@@ -340,87 +426,47 @@ export type ClickableBaseProps = Required<
|
|
|
340
426
|
>
|
|
341
427
|
>;
|
|
342
428
|
/**
|
|
343
|
-
*
|
|
344
|
-
* @publicDocs
|
|
345
|
-
*/
|
|
346
|
-
export interface ClickableProps
|
|
347
|
-
extends Required<BoxProps>,
|
|
348
|
-
ClickableBaseProps {}
|
|
349
|
-
/** * @publicDocs
|
|
429
|
+
* Configure the following properties on the clickable component.
|
|
350
430
|
*/
|
|
351
|
-
export
|
|
352
|
-
export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
|
|
353
|
-
ShadowRoot: (element: any) => ComponentChildren;
|
|
354
|
-
styles?: Styles;
|
|
355
|
-
};
|
|
356
|
-
export interface ActivationEventEsque {
|
|
357
|
-
shiftKey: boolean;
|
|
358
|
-
metaKey: boolean;
|
|
359
|
-
ctrlKey: boolean;
|
|
360
|
-
button: number;
|
|
361
|
-
}
|
|
362
|
-
/** *
|
|
363
|
-
* @publicDocs
|
|
364
|
-
*/
|
|
365
|
-
export interface ClickOptions {
|
|
431
|
+
export interface ClickableProps extends Required<BoxProps>, ClickableBaseProps {
|
|
366
432
|
/**
|
|
367
|
-
*
|
|
433
|
+
* Whether the component is in a loading state, which indicates to assistive technology that an action is in progress and prevents interaction.
|
|
368
434
|
*/
|
|
369
|
-
|
|
435
|
+
loading: Required<ClickableProps$1>['loading'];
|
|
436
|
+
/**
|
|
437
|
+
* The language of the text content.
|
|
438
|
+
*
|
|
439
|
+
* Use this when the text is in a different language than the rest of the page, allowing assistive technologies
|
|
440
|
+
* such as screen readers to invoke the correct pronunciation.
|
|
441
|
+
*
|
|
442
|
+
* The value should be a valid language subtag from the [IANA language subtag registry](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
|
|
443
|
+
*
|
|
444
|
+
* @default ''
|
|
445
|
+
*/
|
|
446
|
+
lang: Required<ClickableProps$1>['lang'];
|
|
447
|
+
/**
|
|
448
|
+
* Whether the component is disabled, preventing clicks and focus. When disabled, the `click` event won't fire and click events from child elements stop propagating immediately. Interactive child elements can still receive focus and be interacted with. This doesn't apply visual styling by default. You should apply disabled styling as needed.
|
|
449
|
+
*/
|
|
450
|
+
disabled: Required<ClickableProps$1>['disabled'];
|
|
370
451
|
}
|
|
371
|
-
/**
|
|
372
|
-
* Base class for creating custom elements with Preact.
|
|
373
|
-
* While this class could be used in both Node and the browser, the constructor will only be used in the browser.
|
|
374
|
-
* So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser.
|
|
375
|
-
*/
|
|
376
|
-
declare const BaseClass: typeof globalThis.HTMLElement;
|
|
377
|
-
declare abstract class PreactCustomElement extends BaseClass {
|
|
378
|
-
/** @private */
|
|
379
|
-
static get observedAttributes(): string[];
|
|
380
|
-
constructor({
|
|
381
|
-
styles,
|
|
382
|
-
ShadowRoot: renderFunction,
|
|
383
|
-
delegatesFocus,
|
|
384
|
-
...options
|
|
385
|
-
}: RenderImpl);
|
|
386
452
|
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
/** @private */
|
|
390
|
-
attributeChangedCallback(name: string): void;
|
|
453
|
+
declare class PolarisCustomElement extends PreactCustomElement {
|
|
454
|
+
constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
|
|
391
455
|
/** @private */
|
|
392
456
|
connectedCallback(): void;
|
|
393
457
|
/** @private */
|
|
394
|
-
disconnectedCallback(): void;
|
|
395
|
-
/** @private */
|
|
396
458
|
adoptedCallback(): void;
|
|
397
|
-
/**
|
|
398
|
-
* Queue a run of the render function.
|
|
399
|
-
* You shouldn't need to call this manually - it should be handled by changes to @property values.
|
|
400
|
-
* @private
|
|
401
|
-
*/
|
|
402
|
-
queueRender(): void;
|
|
403
|
-
/**
|
|
404
|
-
* Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.
|
|
405
|
-
*
|
|
406
|
-
* For example, if the `sourceEvent` was a middle click, or has particular keys held down,
|
|
407
|
-
* components will attempt to produce the desired behavior on links, such as opening the page in the background tab.
|
|
408
|
-
* @private
|
|
409
|
-
* @param options
|
|
410
|
-
*/
|
|
411
|
-
click({sourceEvent}?: ClickOptions): void;
|
|
412
459
|
}
|
|
413
|
-
|
|
414
|
-
*/
|
|
460
|
+
|
|
415
461
|
export interface PreactOverlayControlProps
|
|
416
462
|
extends Pick<InteractionProps, 'commandFor' | 'interestFor'> {
|
|
417
463
|
/**
|
|
418
|
-
* The action
|
|
464
|
+
* The action that [command](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated.
|
|
419
465
|
*
|
|
420
|
-
* - `--auto`:
|
|
421
|
-
* - `--show`:
|
|
422
|
-
* - `--hide`:
|
|
423
|
-
* - `--toggle`:
|
|
466
|
+
* - `--auto`: A default action for the target component.
|
|
467
|
+
* - `--show`: Shows the target component.
|
|
468
|
+
* - `--hide`: Hides the target component.
|
|
469
|
+
* - `--toggle`: Toggles the visibility of the target component.
|
|
424
470
|
*
|
|
425
471
|
* @default '--auto'
|
|
426
472
|
*/
|
|
@@ -429,16 +475,16 @@ export interface PreactOverlayControlProps
|
|
|
429
475
|
'--show' | '--hide' | '--toggle' | '--auto'
|
|
430
476
|
>;
|
|
431
477
|
/**
|
|
432
|
-
*
|
|
478
|
+
* The component that [commandFor](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor) should act on when this component is activated.
|
|
433
479
|
*/
|
|
434
480
|
commandFor: Extract<InteractionProps['commandFor'], string>;
|
|
435
481
|
/**
|
|
436
|
-
*
|
|
482
|
+
* The ID of the component to show when users hover over or focus on this component. Use this to connect interactive components to popovers or tooltips that provide additional context or information.
|
|
437
483
|
*/
|
|
438
484
|
interestFor: Extract<InteractionProps['interestFor'], string>;
|
|
439
485
|
}
|
|
440
486
|
|
|
441
|
-
declare class BoxElement extends
|
|
487
|
+
declare class BoxElement extends PolarisCustomElement implements BoxProps {
|
|
442
488
|
constructor(renderImpl: RenderImpl);
|
|
443
489
|
accessor accessibilityRole: BoxProps['accessibilityRole'];
|
|
444
490
|
accessor background: BoxProps['background'];
|
|
@@ -467,18 +513,50 @@ declare class BoxElement extends PreactCustomElement implements BoxProps {
|
|
|
467
513
|
}
|
|
468
514
|
|
|
469
515
|
declare const Clickable_base: (abstract new (
|
|
470
|
-
renderImpl: RenderImpl,
|
|
516
|
+
renderImpl: _shopify_admin_web_component_foundations.RenderImpl,
|
|
471
517
|
) => BoxElement & PreactOverlayControlProps) &
|
|
472
518
|
Pick<typeof BoxElement, 'prototype' | 'observedAttributes'>;
|
|
519
|
+
/**
|
|
520
|
+
* Configure the following properties on the clickable component.
|
|
521
|
+
* @publicDocs
|
|
522
|
+
*/
|
|
473
523
|
declare class Clickable extends Clickable_base implements ClickableProps {
|
|
474
524
|
accessor disabled: ClickableProps['disabled'];
|
|
475
525
|
accessor loading: ClickableProps['loading'];
|
|
526
|
+
/**
|
|
527
|
+
* The browsing context where the linked URL should be displayed.
|
|
528
|
+
*
|
|
529
|
+
* - `auto`: The target is automatically determined based on the origin of the URL.
|
|
530
|
+
* - `_blank`: Opens the URL in a new window or tab.
|
|
531
|
+
* - `_self`: Opens the URL in the same browsing context as the current one.
|
|
532
|
+
* - `_parent`: Opens the URL in the parent browsing context of the current one. If there is no parent, behaves as `_self`.
|
|
533
|
+
* - `_top`: Opens the URL in the topmost browsing context (the highest ancestor of the current one). If there is no ancestor, behaves as `_self`.
|
|
534
|
+
*/
|
|
476
535
|
accessor target: ClickableProps['target'];
|
|
536
|
+
/**
|
|
537
|
+
* 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.
|
|
538
|
+
*/
|
|
477
539
|
accessor href: ClickableProps['href'];
|
|
540
|
+
/**
|
|
541
|
+
* Prompts the browser to download the linked URL rather than navigate to it. When set, the value specifies the suggested filename for the downloaded file.
|
|
542
|
+
*
|
|
543
|
+
* The filename suggestion is only respected for same-origin URLs, `blob:`, and `data:` schemes. Cross-origin URLs can still trigger downloads, but browsers might ignore the suggested filename.
|
|
544
|
+
*
|
|
545
|
+
* Learn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).
|
|
546
|
+
*/
|
|
478
547
|
accessor download: ClickableProps['download'];
|
|
479
548
|
accessor onclick: CallbackEventListener<typeof tagName> | null;
|
|
480
549
|
accessor onblur: CallbackEventListener<typeof tagName> | null;
|
|
481
550
|
accessor onfocus: CallbackEventListener<typeof tagName> | null;
|
|
551
|
+
/**
|
|
552
|
+
* The behavior of the button component.
|
|
553
|
+
*
|
|
554
|
+
* - `button`: Used to indicate the component acts as a button, meaning it has no default action.
|
|
555
|
+
* - `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).
|
|
556
|
+
* - `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form.
|
|
557
|
+
*
|
|
558
|
+
* This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.
|
|
559
|
+
*/
|
|
482
560
|
accessor type: ClickableProps['type'];
|
|
483
561
|
constructor();
|
|
484
562
|
}
|
|
@@ -497,85 +575,25 @@ declare module 'preact' {
|
|
|
497
575
|
}
|
|
498
576
|
|
|
499
577
|
declare const tagName = 's-clickable';
|
|
500
|
-
/**
|
|
501
|
-
* The JSX properties for the clickable component. These properties define how a clickable container is rendered in Preact or JSX.
|
|
502
|
-
* @publicDocs
|
|
503
|
-
*/
|
|
504
578
|
export interface ClickableJSXProps
|
|
505
579
|
extends Partial<ClickableProps>,
|
|
506
580
|
Pick<ClickableProps$1, 'id' | 'children'> {
|
|
507
581
|
/**
|
|
508
|
-
* The content
|
|
582
|
+
* The content displayed within the clickable component, which makes any content interactive and clickable without the semantic meaning of a button or link.
|
|
509
583
|
*/
|
|
510
584
|
children?: ComponentChildren;
|
|
511
585
|
/**
|
|
512
|
-
* A callback
|
|
586
|
+
* A callback fired when the chip is clicked.
|
|
513
587
|
*/
|
|
514
588
|
onClick?: ((event: CallbackEvent<typeof tagName>) => void) | null;
|
|
515
589
|
/**
|
|
516
|
-
* A callback
|
|
590
|
+
* A callback fired when the chip receives focus.
|
|
517
591
|
*/
|
|
518
592
|
onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
|
|
519
593
|
/**
|
|
520
|
-
* A callback
|
|
594
|
+
* A callback fired when the chip loses focus.
|
|
521
595
|
*/
|
|
522
596
|
onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
|
|
523
|
-
/**
|
|
524
|
-
* 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.
|
|
525
|
-
*
|
|
526
|
-
* @default ''
|
|
527
|
-
*/
|
|
528
|
-
accessibilityLabel?: string;
|
|
529
|
-
/**
|
|
530
|
-
* Whether the component is disabled, preventing interaction. When disabled, the `click` event won't fire and click events from child elements stop propagating immediately. Interactive child elements can still receive focus and be interacted with. This doesn't apply visual styling by default. You should apply disabled styling as needed.
|
|
531
|
-
*
|
|
532
|
-
* @default false
|
|
533
|
-
*/
|
|
534
|
-
disabled?: boolean;
|
|
535
|
-
/**
|
|
536
|
-
* Whether a loading indicator is displayed and interaction is prevented. Set this to `true` to show that an action triggered by the click is in progress.
|
|
537
|
-
*
|
|
538
|
-
* @default false
|
|
539
|
-
*/
|
|
540
|
-
loading?: boolean;
|
|
541
|
-
/**
|
|
542
|
-
* The URL that the component navigates to when clicked. When provided, the component behaves as a link.
|
|
543
|
-
*
|
|
544
|
-
* @default ''
|
|
545
|
-
*/
|
|
546
|
-
href?: string;
|
|
547
|
-
/**
|
|
548
|
-
* Where to open the linked document when the component acts as a link (when `href` is provided). Available options:
|
|
549
|
-
* - `''` - Opens in the same frame (default behavior).
|
|
550
|
-
* - `'_blank'` - Opens in a new window or tab.
|
|
551
|
-
* - `'_self'` - Opens in the same frame (explicit version of default).
|
|
552
|
-
* - `'_parent'` - Opens in the parent frame.
|
|
553
|
-
* - `'_top'` - Opens in the full body of the window.
|
|
554
|
-
*
|
|
555
|
-
* @default ''
|
|
556
|
-
*/
|
|
557
|
-
target?: string;
|
|
558
|
-
/**
|
|
559
|
-
* The filename to save the linked URL as when downloaded. This only works when `href` is provided.
|
|
560
|
-
*
|
|
561
|
-
* @default ''
|
|
562
|
-
*/
|
|
563
|
-
download?: string;
|
|
564
|
-
/**
|
|
565
|
-
* The language of the component's content, specified as a BCP 47 language tag (such as `en` or `fr`). This helps assistive technologies pronounce content correctly.
|
|
566
|
-
*
|
|
567
|
-
* @default ''
|
|
568
|
-
*/
|
|
569
|
-
lang?: string;
|
|
570
|
-
/**
|
|
571
|
-
* The component's behavior in forms when it's used as a form control. Available options:
|
|
572
|
-
* - `'button'` - A standard clickable with no default behavior.
|
|
573
|
-
* - `'submit'` - Submits the form data to the server.
|
|
574
|
-
* - `'reset'` - Resets all form controls to their initial values.
|
|
575
|
-
*
|
|
576
|
-
* @default 'button'
|
|
577
|
-
*/
|
|
578
|
-
type?: string;
|
|
579
597
|
}
|
|
580
598
|
|
|
581
599
|
export {Clickable};
|