@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 */
|
|
@@ -6,11 +6,60 @@
|
|
|
6
6
|
|
|
7
7
|
// eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
|
|
8
8
|
/// <reference lib="DOM" />
|
|
9
|
-
import type {
|
|
9
|
+
import type {
|
|
10
|
+
ComponentChildren,
|
|
11
|
+
HeadingProps$1,
|
|
12
|
+
PreactCustomElement,
|
|
13
|
+
RenderImpl,
|
|
14
|
+
} from './shared.d.ts';
|
|
15
|
+
import * as preact$1 from 'preact';
|
|
16
|
+
import {ReactNode, RefAttributes} from 'react';
|
|
17
|
+
|
|
18
|
+
export type ReactIntrinsicElementChildren<PreactProps extends object> =
|
|
19
|
+
'children' extends keyof PreactProps
|
|
20
|
+
? {
|
|
21
|
+
children?: ReactNode;
|
|
22
|
+
}
|
|
23
|
+
: Record<never, never>;
|
|
24
|
+
export type ReactIntrinsicElementProps<
|
|
25
|
+
PreactProps extends object,
|
|
26
|
+
ElementType,
|
|
27
|
+
> = Omit<PreactProps, 'children' | 'key' | 'ref' | 'slot'> &
|
|
28
|
+
ReactIntrinsicElementChildren<PreactProps> &
|
|
29
|
+
RefAttributes<ElementType> & {
|
|
30
|
+
slot?: Lowercase<string>;
|
|
31
|
+
};
|
|
32
|
+
export type ReactIntrinsicElements = {
|
|
33
|
+
[Tag in Exclude<
|
|
34
|
+
Extract<keyof preact$1.createElement.JSX.IntrinsicElements, `s-${string}`>,
|
|
35
|
+
`s-test-${string}`
|
|
36
|
+
>]: ReactIntrinsicElementProps<
|
|
37
|
+
preact$1.createElement.JSX.IntrinsicElements[Tag],
|
|
38
|
+
Tag extends keyof HTMLElementTagNameMap
|
|
39
|
+
? HTMLElementTagNameMap[Tag]
|
|
40
|
+
: HTMLElement
|
|
41
|
+
>;
|
|
42
|
+
};
|
|
43
|
+
declare module 'react' {
|
|
44
|
+
namespace JSX {
|
|
45
|
+
interface IntrinsicElements extends ReactIntrinsicElements {}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
declare const headingFontSizes: readonly [
|
|
50
|
+
'auto',
|
|
51
|
+
'small',
|
|
52
|
+
'base',
|
|
53
|
+
'large',
|
|
54
|
+
'large-100',
|
|
55
|
+
'large-200',
|
|
56
|
+
'large-300',
|
|
57
|
+
'large-400',
|
|
58
|
+
];
|
|
59
|
+
export type HeadingFontSize = (typeof headingFontSizes)[number];
|
|
10
60
|
|
|
11
61
|
/**
|
|
12
|
-
*
|
|
13
|
-
* @publicDocs
|
|
62
|
+
* Configure the following properties on the heading component.
|
|
14
63
|
*/
|
|
15
64
|
export interface HeadingProps
|
|
16
65
|
extends Required<
|
|
@@ -18,146 +67,101 @@ export interface HeadingProps
|
|
|
18
67
|
HeadingProps$1,
|
|
19
68
|
'accessibilityRole' | 'accessibilityVisibility' | 'lineClamp'
|
|
20
69
|
>
|
|
21
|
-
> {
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* A string containing CSS styles.
|
|
25
|
-
* @publicDocs
|
|
26
|
-
*/
|
|
27
|
-
export type Styles = string;
|
|
28
|
-
/**
|
|
29
|
-
* The configuration for rendering a custom element with a shadow DOM.
|
|
30
|
-
* @publicDocs
|
|
31
|
-
*/
|
|
32
|
-
export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
|
|
33
|
-
/**
|
|
34
|
-
* The function that renders the component's shadow DOM content.
|
|
35
|
-
*/
|
|
36
|
-
ShadowRoot: (element: any) => ComponentChildren;
|
|
37
|
-
/**
|
|
38
|
-
* Optional CSS styles to apply to the shadow DOM.
|
|
39
|
-
*/
|
|
40
|
-
styles?: Styles;
|
|
41
|
-
};
|
|
42
|
-
/**
|
|
43
|
-
* An object that represents the state of modifier keys and mouse button
|
|
44
|
-
* during an activation event like a click.
|
|
45
|
-
* @publicDocs
|
|
46
|
-
*/
|
|
47
|
-
export interface ActivationEventEsque {
|
|
48
|
-
/**
|
|
49
|
-
* Whether the shift key was pressed during the event.
|
|
50
|
-
*/
|
|
51
|
-
shiftKey: boolean;
|
|
52
|
-
/**
|
|
53
|
-
* Whether the meta (Command on Mac, Windows key on PC) key was pressed.
|
|
54
|
-
*/
|
|
55
|
-
metaKey: boolean;
|
|
56
|
-
/**
|
|
57
|
-
* Whether the control key was pressed during the event.
|
|
58
|
-
*/
|
|
59
|
-
ctrlKey: boolean;
|
|
60
|
-
/**
|
|
61
|
-
* The mouse button that was pressed (0 for left, 1 for middle, 2 for right).
|
|
62
|
-
*/
|
|
63
|
-
button: number;
|
|
64
|
-
}
|
|
65
|
-
/**
|
|
66
|
-
* Options for customizing click behavior on an element.
|
|
67
|
-
* @publicDocs
|
|
68
|
-
*/
|
|
69
|
-
export interface ClickOptions {
|
|
70
|
-
/**
|
|
71
|
-
* The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked.
|
|
72
|
-
*/
|
|
73
|
-
sourceEvent?: ActivationEventEsque;
|
|
74
|
-
}
|
|
75
|
-
/**
|
|
76
|
-
* Base class for creating custom elements with Preact.
|
|
77
|
-
* While this class could be used in both Node and the browser, the constructor will only be used in the browser.
|
|
78
|
-
* So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser.
|
|
79
|
-
*/
|
|
80
|
-
declare const BaseClass: typeof globalThis.HTMLElement;
|
|
81
|
-
declare abstract class PreactCustomElement extends BaseClass {
|
|
82
|
-
/** @private */
|
|
83
|
-
static get observedAttributes(): string[];
|
|
84
|
-
constructor({
|
|
85
|
-
styles,
|
|
86
|
-
ShadowRoot: renderFunction,
|
|
87
|
-
delegatesFocus,
|
|
88
|
-
...options
|
|
89
|
-
}: RenderImpl);
|
|
90
|
-
|
|
91
|
-
/** @private */
|
|
92
|
-
setAttribute(name: string, value: string): void;
|
|
93
|
-
/** @private */
|
|
94
|
-
attributeChangedCallback(name: string): void;
|
|
95
|
-
/** @private */
|
|
96
|
-
connectedCallback(): void;
|
|
97
|
-
/** @private */
|
|
98
|
-
disconnectedCallback(): void;
|
|
99
|
-
/** @private */
|
|
100
|
-
adoptedCallback(): void;
|
|
70
|
+
> {
|
|
101
71
|
/**
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
72
|
+
* The font size of the heading. The named values also apply their matching
|
|
73
|
+
* line-height and letter-spacing:
|
|
74
|
+
*
|
|
75
|
+
* - 'small' maps to headingXs
|
|
76
|
+
* - 'base' maps to headingSm
|
|
77
|
+
* - 'large' / 'large-100' maps to headingMd
|
|
78
|
+
* - 'large-200' maps to headingLg
|
|
79
|
+
* - 'large-300' maps to headingXl
|
|
80
|
+
* - 'large-400' maps to heading2xl
|
|
81
|
+
*
|
|
82
|
+
* @default 'auto'
|
|
105
83
|
*/
|
|
106
|
-
|
|
84
|
+
fontSize: HeadingFontSize;
|
|
107
85
|
/**
|
|
108
|
-
*
|
|
86
|
+
* The semantic meaning of the component’s content. When set,
|
|
87
|
+
* the role will be used by assistive technologies to help users
|
|
88
|
+
* navigate the page.
|
|
109
89
|
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
90
|
+
* - `heading`: Identifies the element as a heading for assistive technologies.
|
|
91
|
+
* - `none`: Removes semantic meaning from the heading element.
|
|
92
|
+
* - `presentation`: Removes semantic meaning from the heading element.
|
|
93
|
+
*
|
|
94
|
+
* @default 'heading'
|
|
95
|
+
*
|
|
96
|
+
* @implementation The `heading` role doesn't need to be applied if
|
|
97
|
+
* the host applies it for you; for example, an HTML host rendering
|
|
98
|
+
* an `<h2>` element should not apply the `heading` role.
|
|
114
99
|
*/
|
|
115
|
-
|
|
100
|
+
accessibilityRole: Required<HeadingProps$1>['accessibilityRole'];
|
|
116
101
|
}
|
|
117
102
|
|
|
118
103
|
/**
|
|
119
|
-
*
|
|
104
|
+
* 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.
|
|
120
105
|
* @publicDocs
|
|
121
106
|
*/
|
|
122
107
|
export interface PreactBaseElementProps<TClass extends HTMLElement> {
|
|
123
108
|
/**
|
|
124
|
-
* A unique identifier for this element
|
|
109
|
+
* A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists.
|
|
110
|
+
* Essential for maintaining component state and optimizing re-renders when lists change.
|
|
125
111
|
*/
|
|
126
112
|
key?: preact.Key;
|
|
127
113
|
/**
|
|
128
|
-
* A reference to the underlying DOM element
|
|
114
|
+
* A reference to access the underlying DOM element directly.
|
|
115
|
+
* Typically created using `useRef()` to interact with the element imperatively or measure its properties.
|
|
129
116
|
*/
|
|
130
117
|
ref?: preact.Ref<TClass>;
|
|
131
118
|
/**
|
|
132
|
-
*
|
|
119
|
+
* The named slot to which this element is assigned in the parent component's shadow DOM.
|
|
120
|
+
*
|
|
121
|
+
* Used for advanced component composition with web components.
|
|
133
122
|
*/
|
|
134
123
|
slot?: Lowercase<string>;
|
|
135
124
|
}
|
|
136
125
|
/**
|
|
137
|
-
*
|
|
126
|
+
* Base props for Preact custom elements with children support. Extends PreactBaseElementProps with the ability to render child elements.
|
|
138
127
|
* @publicDocs
|
|
139
128
|
*/
|
|
140
129
|
export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
|
|
141
130
|
extends PreactBaseElementProps<TClass> {
|
|
131
|
+
/**
|
|
132
|
+
* The child elements to be rendered within this component.
|
|
133
|
+
*/
|
|
142
134
|
children?: preact.ComponentChildren;
|
|
143
135
|
}
|
|
144
136
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
*/
|
|
148
|
-
|
|
149
|
-
/**
|
|
150
|
-
|
|
151
|
-
|
|
137
|
+
declare class PolarisCustomElement extends PreactCustomElement {
|
|
138
|
+
constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
|
|
139
|
+
/** @private */
|
|
140
|
+
connectedCallback(): void;
|
|
141
|
+
/** @private */
|
|
142
|
+
adoptedCallback(): void;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
declare abstract class HeadingBase
|
|
146
|
+
extends PolarisCustomElement
|
|
147
|
+
implements
|
|
148
|
+
Pick<
|
|
149
|
+
HeadingProps,
|
|
150
|
+
'accessibilityRole' | 'accessibilityVisibility' | 'fontSize' | 'lineClamp'
|
|
151
|
+
>
|
|
152
|
+
{
|
|
153
|
+
accessor fontSize: HeadingProps['fontSize'];
|
|
152
154
|
accessor accessibilityRole: HeadingProps['accessibilityRole'];
|
|
153
|
-
/**
|
|
154
|
-
* The maximum number of lines to display before the text is truncated with an ellipsis.
|
|
155
|
-
*/
|
|
156
155
|
accessor lineClamp: HeadingProps['lineClamp'];
|
|
157
|
-
/**
|
|
158
|
-
* The visibility of the element to assistive technologies.
|
|
159
|
-
*/
|
|
160
156
|
accessor accessibilityVisibility: HeadingProps['accessibilityVisibility'];
|
|
157
|
+
constructor(renderImpl: RenderImpl);
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
/**
|
|
161
|
+
* Configure the following properties on the heading component.
|
|
162
|
+
* @publicDocs
|
|
163
|
+
*/
|
|
164
|
+
declare class Heading extends HeadingBase implements HeadingProps {
|
|
161
165
|
constructor();
|
|
162
166
|
}
|
|
163
167
|
declare global {
|
|
@@ -174,15 +178,11 @@ declare module 'preact' {
|
|
|
174
178
|
}
|
|
175
179
|
|
|
176
180
|
declare const tagName = 's-heading';
|
|
177
|
-
/**
|
|
178
|
-
* The JSX properties for the heading component. These properties define how a heading is rendered in Preact or JSX.
|
|
179
|
-
* @publicDocs
|
|
180
|
-
*/
|
|
181
181
|
export interface HeadingJSXProps
|
|
182
182
|
extends Partial<HeadingProps>,
|
|
183
183
|
Pick<HeadingProps$1, 'id' | 'children'> {
|
|
184
184
|
/**
|
|
185
|
-
* The
|
|
185
|
+
* The heading text displayed within the heading component, which provides a title or section header for content.
|
|
186
186
|
*/
|
|
187
187
|
children?: ComponentChildren;
|
|
188
188
|
}
|
|
@@ -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 */
|
|
@@ -6,19 +6,71 @@
|
|
|
6
6
|
|
|
7
7
|
// eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
|
|
8
8
|
/// <reference lib="DOM" />
|
|
9
|
-
import type {
|
|
9
|
+
import type {
|
|
10
|
+
IconProps$1,
|
|
11
|
+
IconType,
|
|
12
|
+
PreactCustomElement,
|
|
13
|
+
RenderImpl,
|
|
14
|
+
} from './shared.d.ts';
|
|
15
|
+
import * as preact$1 from 'preact';
|
|
16
|
+
import {ReactNode, RefAttributes} from 'react';
|
|
10
17
|
|
|
18
|
+
export type ReactIntrinsicElementChildren<PreactProps extends object> =
|
|
19
|
+
'children' extends keyof PreactProps
|
|
20
|
+
? {
|
|
21
|
+
children?: ReactNode;
|
|
22
|
+
}
|
|
23
|
+
: Record<never, never>;
|
|
24
|
+
export type ReactIntrinsicElementProps<
|
|
25
|
+
PreactProps extends object,
|
|
26
|
+
ElementType,
|
|
27
|
+
> = Omit<PreactProps, 'children' | 'key' | 'ref' | 'slot'> &
|
|
28
|
+
ReactIntrinsicElementChildren<PreactProps> &
|
|
29
|
+
RefAttributes<ElementType> & {
|
|
30
|
+
slot?: Lowercase<string>;
|
|
31
|
+
};
|
|
32
|
+
export type ReactIntrinsicElements = {
|
|
33
|
+
[Tag in Exclude<
|
|
34
|
+
Extract<keyof preact$1.createElement.JSX.IntrinsicElements, `s-${string}`>,
|
|
35
|
+
`s-test-${string}`
|
|
36
|
+
>]: ReactIntrinsicElementProps<
|
|
37
|
+
preact$1.createElement.JSX.IntrinsicElements[Tag],
|
|
38
|
+
Tag extends keyof HTMLElementTagNameMap
|
|
39
|
+
? HTMLElementTagNameMap[Tag]
|
|
40
|
+
: HTMLElement
|
|
41
|
+
>;
|
|
42
|
+
};
|
|
43
|
+
declare module 'react' {
|
|
44
|
+
namespace JSX {
|
|
45
|
+
interface IntrinsicElements extends ReactIntrinsicElements {}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Configure the following properties on the icon component.
|
|
51
|
+
*/
|
|
11
52
|
export interface IconProps
|
|
12
|
-
extends
|
|
13
|
-
IconProps$1,
|
|
14
|
-
'type' | 'tone' | 'color' | 'size' | 'interestFor'
|
|
53
|
+
extends Required<
|
|
54
|
+
Pick<IconProps$1, 'type' | 'tone' | 'color' | 'size' | 'interestFor'>
|
|
15
55
|
> {
|
|
16
56
|
/**
|
|
17
|
-
* The
|
|
57
|
+
* The icon to display from the icon library.
|
|
58
|
+
*
|
|
59
|
+
* Set to a valid icon name to display that icon. To hide the icon completely,
|
|
60
|
+
* use an empty string `''`. To reserve the icon's space without displaying an icon,
|
|
61
|
+
* use `'empty'`.
|
|
18
62
|
*/
|
|
19
63
|
type: '' | IconType | 'empty';
|
|
20
64
|
/**
|
|
21
|
-
* The
|
|
65
|
+
* The semantic meaning and color treatment of the component.
|
|
66
|
+
*
|
|
67
|
+
* - `info`: Informational content or helpful tips.
|
|
68
|
+
* - `success`: Positive outcomes or successful states.
|
|
69
|
+
* - `warning`: Important warnings about potential issues.
|
|
70
|
+
* - `critical`: Urgent problems or destructive actions.
|
|
71
|
+
* - `auto`: Automatically determined based on context.
|
|
72
|
+
* - `neutral`: General information without specific intent.
|
|
73
|
+
* - `caution`: Advisory notices that need attention.
|
|
22
74
|
*
|
|
23
75
|
* @default 'auto'
|
|
24
76
|
*/
|
|
@@ -27,159 +79,73 @@ export interface IconProps
|
|
|
27
79
|
'auto' | 'neutral' | 'info' | 'success' | 'caution' | 'warning' | 'critical'
|
|
28
80
|
>;
|
|
29
81
|
/**
|
|
30
|
-
* The color emphasis
|
|
82
|
+
* The color emphasis level that controls visual intensity.
|
|
83
|
+
*
|
|
84
|
+
* - `base`: Primary color for body text, standard UI elements, and general content with good readability.
|
|
85
|
+
* - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.
|
|
31
86
|
*
|
|
32
87
|
* @default 'base'
|
|
33
88
|
*/
|
|
34
89
|
color: Extract<IconProps$1['color'], 'base' | 'subdued'>;
|
|
35
90
|
/**
|
|
36
|
-
* The size of the icon.
|
|
91
|
+
* The size of the icon.
|
|
37
92
|
*
|
|
38
|
-
*
|
|
93
|
+
* - `small`: Smaller icon suitable for inline use within text or compact UI elements.
|
|
94
|
+
* - `base`: Default size that works well for standalone icons and standard use cases.
|
|
39
95
|
*/
|
|
40
96
|
size: Extract<IconProps$1['size'], 'small' | 'base'>;
|
|
41
97
|
}
|
|
42
98
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
* @publicDocs
|
|
46
|
-
*/
|
|
47
|
-
export type Styles = string;
|
|
48
|
-
/**
|
|
49
|
-
* The implementation details for rendering a custom element with Preact.
|
|
50
|
-
* @publicDocs
|
|
51
|
-
*/
|
|
52
|
-
export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
|
|
53
|
-
/**
|
|
54
|
-
* The function that renders the component's shadow root content.
|
|
55
|
-
*/
|
|
56
|
-
ShadowRoot: (element: any) => ComponentChildren;
|
|
57
|
-
/**
|
|
58
|
-
* Optional CSS styles to apply to the shadow root.
|
|
59
|
-
*/
|
|
60
|
-
styles?: Styles;
|
|
61
|
-
};
|
|
62
|
-
/**
|
|
63
|
-
* The properties of an activation event, such as a click or keypress. These properties capture which modifier keys were pressed and which mouse button was used during the event.
|
|
64
|
-
* @publicDocs
|
|
65
|
-
*/
|
|
66
|
-
export interface ActivationEventEsque {
|
|
67
|
-
/**
|
|
68
|
-
* Whether the shift key was pressed during activation.
|
|
69
|
-
*/
|
|
70
|
-
shiftKey: boolean;
|
|
71
|
-
/**
|
|
72
|
-
* Whether the meta key (Command on Mac, Windows key on Windows) was pressed during activation.
|
|
73
|
-
*/
|
|
74
|
-
metaKey: boolean;
|
|
75
|
-
/**
|
|
76
|
-
* Whether the control key was pressed during activation.
|
|
77
|
-
*/
|
|
78
|
-
ctrlKey: boolean;
|
|
79
|
-
/**
|
|
80
|
-
* The mouse button that was pressed during activation.
|
|
81
|
-
*/
|
|
82
|
-
button: number;
|
|
83
|
-
}
|
|
84
|
-
/**
|
|
85
|
-
* The options for customizing synthetic click behavior.
|
|
86
|
-
* @publicDocs
|
|
87
|
-
*/
|
|
88
|
-
export interface ClickOptions {
|
|
89
|
-
/**
|
|
90
|
-
* The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked.
|
|
91
|
-
*/
|
|
92
|
-
sourceEvent?: ActivationEventEsque;
|
|
93
|
-
}
|
|
94
|
-
/**
|
|
95
|
-
* The base class for creating custom elements with Preact.
|
|
96
|
-
* While this class could be used in both Node and the browser, the constructor will only be used in the browser.
|
|
97
|
-
* So we give it a type of `HTMLElement` to avoid typing issues later where it's used, which will only happen in the browser.
|
|
98
|
-
*/
|
|
99
|
-
declare const BaseClass: typeof globalThis.HTMLElement;
|
|
100
|
-
/**
|
|
101
|
-
* An abstract base class for creating custom elements that render with Preact.
|
|
102
|
-
*/
|
|
103
|
-
declare abstract class PreactCustomElement extends BaseClass {
|
|
104
|
-
/** @private */
|
|
105
|
-
static get observedAttributes(): string[];
|
|
106
|
-
constructor({
|
|
107
|
-
styles,
|
|
108
|
-
ShadowRoot: renderFunction,
|
|
109
|
-
delegatesFocus,
|
|
110
|
-
...options
|
|
111
|
-
}: RenderImpl);
|
|
112
|
-
|
|
113
|
-
/** @private */
|
|
114
|
-
setAttribute(name: string, value: string): void;
|
|
115
|
-
/** @private */
|
|
116
|
-
attributeChangedCallback(name: string): void;
|
|
99
|
+
declare class PolarisCustomElement extends PreactCustomElement {
|
|
100
|
+
constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
|
|
117
101
|
/** @private */
|
|
118
102
|
connectedCallback(): void;
|
|
119
103
|
/** @private */
|
|
120
|
-
disconnectedCallback(): void;
|
|
121
|
-
/** @private */
|
|
122
104
|
adoptedCallback(): void;
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
* @param options
|
|
136
|
-
*/
|
|
137
|
-
click({sourceEvent}?: ClickOptions): void;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
declare abstract class IconBase
|
|
108
|
+
extends PolarisCustomElement
|
|
109
|
+
implements Pick<IconProps, 'color' | 'size' | 'interestFor'>
|
|
110
|
+
{
|
|
111
|
+
accessor color: IconProps['color'];
|
|
112
|
+
accessor size: IconProps['size'];
|
|
113
|
+
accessor interestFor: IconProps['interestFor'];
|
|
114
|
+
abstract tone: string;
|
|
115
|
+
abstract type: string;
|
|
116
|
+
constructor(renderImpl: RenderImpl);
|
|
138
117
|
}
|
|
139
118
|
|
|
140
119
|
/**
|
|
141
|
-
*
|
|
120
|
+
* 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.
|
|
142
121
|
* @publicDocs
|
|
143
122
|
*/
|
|
144
123
|
export interface PreactBaseElementProps<TClass extends HTMLElement> {
|
|
145
124
|
/**
|
|
146
|
-
* A unique identifier for this element
|
|
125
|
+
* A unique identifier for this element, used by the virtual DOM to efficiently track and update elements in lists.
|
|
126
|
+
* Essential for maintaining component state and optimizing re-renders when lists change.
|
|
147
127
|
*/
|
|
148
128
|
key?: preact.Key;
|
|
149
129
|
/**
|
|
150
|
-
* A reference to the underlying DOM element
|
|
130
|
+
* A reference to access the underlying DOM element directly.
|
|
131
|
+
* Typically created using `useRef()` to interact with the element imperatively or measure its properties.
|
|
151
132
|
*/
|
|
152
133
|
ref?: preact.Ref<TClass>;
|
|
153
134
|
/**
|
|
154
|
-
*
|
|
135
|
+
* The named slot to which this element is assigned in the parent component's shadow DOM.
|
|
136
|
+
*
|
|
137
|
+
* Used for advanced component composition with web components.
|
|
155
138
|
*/
|
|
156
139
|
slot?: Lowercase<string>;
|
|
157
140
|
}
|
|
158
141
|
|
|
159
142
|
/**
|
|
160
|
-
*
|
|
143
|
+
* Configure the following properties on the icon component.
|
|
144
|
+
* @publicDocs
|
|
161
145
|
*/
|
|
162
|
-
declare class Icon extends
|
|
163
|
-
/**
|
|
164
|
-
* The color emphasis of the icon.
|
|
165
|
-
*/
|
|
166
|
-
accessor color: IconProps['color'];
|
|
167
|
-
/**
|
|
168
|
-
* The color tone of the icon based on its semantic meaning.
|
|
169
|
-
*/
|
|
146
|
+
declare class Icon extends IconBase implements IconProps {
|
|
170
147
|
accessor tone: IconProps['tone'];
|
|
171
|
-
/**
|
|
172
|
-
* The type of icon to display.
|
|
173
|
-
*/
|
|
174
148
|
accessor type: IconProps['type'];
|
|
175
|
-
/**
|
|
176
|
-
* The size of the icon.
|
|
177
|
-
*/
|
|
178
|
-
accessor size: IconProps['size'];
|
|
179
|
-
/**
|
|
180
|
-
* The element that this icon should show interest for when activated.
|
|
181
|
-
*/
|
|
182
|
-
accessor interestFor: string;
|
|
183
149
|
constructor();
|
|
184
150
|
}
|
|
185
151
|
declare global {
|
|
@@ -196,10 +162,6 @@ declare module 'preact' {
|
|
|
196
162
|
}
|
|
197
163
|
|
|
198
164
|
declare const tagName = 's-icon';
|
|
199
|
-
/**
|
|
200
|
-
* The properties for the icon component when it's used in JSX.
|
|
201
|
-
* @publicDocs
|
|
202
|
-
*/
|
|
203
165
|
export interface IconJSXProps
|
|
204
166
|
extends Partial<IconProps>,
|
|
205
167
|
Pick<IconProps$1, 'id'> {}
|