@shopify/ui-extensions 2026.4.0-rc.3 → 2026.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/surfaces/checkout/preact/api.js +2 -0
- package/build/cjs/surfaces/checkout/preact/app-metafields.js +1 -0
- package/build/cjs/surfaces/checkout/preact/attributes.js +3 -0
- package/build/cjs/surfaces/checkout/preact/billing-address.js +1 -0
- package/build/cjs/surfaces/checkout/preact/buyer-identity.js +4 -0
- package/build/cjs/surfaces/checkout/preact/buyer-journey.js +5 -0
- package/build/cjs/surfaces/checkout/preact/capabilities.js +2 -0
- package/build/cjs/surfaces/checkout/preact/cart-line-target.js +1 -0
- package/build/cjs/surfaces/checkout/preact/cart-lines.js +2 -0
- package/build/cjs/surfaces/checkout/preact/checkout-settings.js +1 -0
- package/build/cjs/surfaces/checkout/preact/checkout-token.js +1 -0
- package/build/cjs/surfaces/checkout/preact/cost.js +4 -0
- package/build/cjs/surfaces/checkout/preact/country.js +1 -0
- package/build/cjs/surfaces/checkout/preact/currency.js +1 -0
- package/build/cjs/surfaces/checkout/preact/customer-privacy.js +1 -0
- package/build/cjs/surfaces/checkout/preact/delivery-group-list-target.js +1 -0
- package/build/cjs/surfaces/checkout/preact/delivery-group-target.js +1 -0
- package/build/cjs/surfaces/checkout/preact/delivery-group.js +1 -0
- package/build/cjs/surfaces/checkout/preact/delivery-groups.js +1 -0
- package/build/cjs/surfaces/checkout/preact/delivery-selection-groups.js +1 -0
- package/build/cjs/surfaces/checkout/preact/discounts.js +3 -0
- package/build/cjs/surfaces/checkout/preact/extension-editor.js +1 -0
- package/build/cjs/surfaces/checkout/preact/extension-language.js +1 -0
- package/build/cjs/surfaces/checkout/preact/extension.js +2 -0
- package/build/cjs/surfaces/checkout/preact/gift-cards.js +2 -0
- package/build/cjs/surfaces/checkout/preact/instructions.js +1 -0
- package/build/cjs/surfaces/checkout/preact/language.js +1 -0
- package/build/cjs/surfaces/checkout/preact/localized-fields.js +2 -0
- package/build/cjs/surfaces/checkout/preact/market.js +1 -0
- package/build/cjs/surfaces/checkout/preact/metafields.js +1 -0
- package/build/cjs/surfaces/checkout/preact/note.js +2 -0
- package/build/cjs/surfaces/checkout/preact/payment-method.js +3 -0
- package/build/cjs/surfaces/checkout/preact/payment-options.js +2 -0
- package/build/cjs/surfaces/checkout/preact/pickup-location-option-target.js +1 -0
- package/build/cjs/surfaces/checkout/preact/redeemable.js +1 -0
- package/build/cjs/surfaces/checkout/preact/session-token.js +1 -0
- package/build/cjs/surfaces/checkout/preact/settings.js +1 -0
- package/build/cjs/surfaces/checkout/preact/shipping-address.js +2 -0
- package/build/cjs/surfaces/checkout/preact/shipping-option-target.js +1 -0
- package/build/cjs/surfaces/checkout/preact/shop.js +1 -0
- package/build/cjs/surfaces/checkout/preact/storage.js +1 -0
- package/build/cjs/surfaces/checkout/preact/subscription.js +1 -0
- package/build/cjs/surfaces/checkout/preact/target.js +1 -0
- package/build/cjs/surfaces/checkout/preact/timezone.js +1 -0
- package/build/cjs/surfaces/checkout/preact/translate.js +1 -0
- package/build/cjs/surfaces/checkout/shared.js +3 -16
- package/build/cjs/surfaces/checkout/style/style.js +1 -0
- package/build/cjs/surfaces/point-of-sale/types/storage.js +4 -0
- package/build/esm/surfaces/checkout/preact/api.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/app-metafields.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/attributes.mjs +3 -0
- package/build/esm/surfaces/checkout/preact/billing-address.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/buyer-identity.mjs +4 -0
- package/build/esm/surfaces/checkout/preact/buyer-journey.mjs +5 -0
- package/build/esm/surfaces/checkout/preact/capabilities.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/cart-line-target.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/cart-lines.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/checkout-settings.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/checkout-token.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/cost.mjs +4 -0
- package/build/esm/surfaces/checkout/preact/country.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/currency.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/customer-privacy.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/delivery-group-list-target.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/delivery-group-target.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/delivery-group.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/delivery-groups.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/delivery-selection-groups.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/discounts.mjs +3 -0
- package/build/esm/surfaces/checkout/preact/extension-editor.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/extension-language.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/extension.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/gift-cards.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/instructions.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/language.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/localized-fields.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/market.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/metafields.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/note.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/payment-method.mjs +3 -0
- package/build/esm/surfaces/checkout/preact/payment-options.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/pickup-location-option-target.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/redeemable.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/session-token.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/settings.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/shipping-address.mjs +2 -0
- package/build/esm/surfaces/checkout/preact/shipping-option-target.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/shop.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/storage.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/subscription.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/target.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/timezone.mjs +1 -0
- package/build/esm/surfaces/checkout/preact/translate.mjs +1 -0
- package/build/esm/surfaces/checkout/shared.mjs +3 -16
- package/build/esm/surfaces/checkout/style/style.mjs +1 -0
- package/build/esm/surfaces/point-of-sale/types/storage.mjs +4 -0
- package/build/esnext/surfaces/checkout/preact/api.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/app-metafields.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/attributes.esnext +3 -0
- package/build/esnext/surfaces/checkout/preact/billing-address.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/buyer-identity.esnext +4 -0
- package/build/esnext/surfaces/checkout/preact/buyer-journey.esnext +5 -0
- package/build/esnext/surfaces/checkout/preact/capabilities.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/cart-line-target.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/cart-lines.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/checkout-settings.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/checkout-token.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/cost.esnext +4 -0
- package/build/esnext/surfaces/checkout/preact/country.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/currency.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/customer-privacy.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/delivery-group-list-target.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/delivery-group-target.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/delivery-group.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/delivery-groups.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/delivery-selection-groups.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/discounts.esnext +3 -0
- package/build/esnext/surfaces/checkout/preact/extension-editor.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/extension-language.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/extension.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/gift-cards.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/instructions.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/language.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/localized-fields.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/market.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/metafields.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/note.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/payment-method.esnext +3 -0
- package/build/esnext/surfaces/checkout/preact/payment-options.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/pickup-location-option-target.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/redeemable.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/session-token.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/settings.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/shipping-address.esnext +2 -0
- package/build/esnext/surfaces/checkout/preact/shipping-option-target.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/shop.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/storage.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/subscription.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/target.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/timezone.esnext +1 -0
- package/build/esnext/surfaces/checkout/preact/translate.esnext +1 -0
- package/build/esnext/surfaces/checkout/shared.esnext +3 -16
- package/build/esnext/surfaces/checkout/style/style.esnext +1 -0
- package/build/esnext/surfaces/point-of-sale/types/storage.esnext +4 -0
- package/build/ts/shared.d.ts +32 -12
- package/build/ts/shared.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/action/action.d.ts +1 -0
- package/build/ts/surfaces/admin/api/action/action.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/block/block.d.ts +2 -0
- package/build/ts/surfaces/admin/api/block/block.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/checkout-rules/launch-options.d.ts +7 -4
- package/build/ts/surfaces/admin/api/checkout-rules/launch-options.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/checkout-rules/metafields.d.ts +13 -7
- package/build/ts/surfaces/admin/api/checkout-rules/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/checkout-rules/validation-settings.d.ts +1 -0
- package/build/ts/surfaces/admin/api/checkout-rules/validation-settings.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.d.ts +3 -0
- package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/discount-function-settings.d.ts +1 -0
- package/build/ts/surfaces/admin/api/discount-function-settings/discount-function-settings.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts +7 -3
- package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/discount-function-settings/metafields.d.ts +13 -7
- package/build/ts/surfaces/admin/api/discount-function-settings/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/generated/generated.d.ts +62 -0
- package/build/ts/surfaces/admin/api/generated/generated.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api/intents/intent-render.d.ts +24 -0
- package/build/ts/surfaces/admin/api/intents/intent-render.d.ts.map +1 -0
- package/build/ts/surfaces/admin/api/intents/intents.d.ts +44 -8
- package/build/ts/surfaces/admin/api/intents/intents.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/order-routing-rule/data.d.ts +5 -3
- package/build/ts/surfaces/admin/api/order-routing-rule/data.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/order-routing-rule/metafields.d.ts +8 -3
- package/build/ts/surfaces/admin/api/order-routing-rule/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.d.ts +1 -0
- package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/picker/picker.d.ts +15 -7
- package/build/ts/surfaces/admin/api/picker/picker.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/print-action/print-action.d.ts +1 -0
- package/build/ts/surfaces/admin/api/print-action/print-action.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts +4 -2
- package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.d.ts +4 -2
- package/build/ts/surfaces/admin/api/product-configuration/product-variant-details-configuration.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/purchase-options-card-action.d.ts +1 -0
- package/build/ts/surfaces/admin/api/purchase-options-card-action.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/resource-picker/resource-picker.d.ts +36 -17
- package/build/ts/surfaces/admin/api/resource-picker/resource-picker.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/shared.d.ts +2 -0
- package/build/ts/surfaces/admin/api/shared.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/standard/standard-rendering.d.ts +3 -0
- package/build/ts/surfaces/admin/api/standard/standard-rendering.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/standard/standard.d.ts +4 -1
- package/build/ts/surfaces/admin/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api/standard/storage.d.ts +4 -0
- package/build/ts/surfaces/admin/api/standard/storage.d.ts.map +1 -1
- package/build/ts/surfaces/admin/api.d.ts +2 -0
- package/build/ts/surfaces/admin/api.d.ts.map +1 -1
- package/build/ts/surfaces/admin/components/AdminAction.d.ts +6 -0
- package/build/ts/surfaces/admin/components/AdminBlock.d.ts +6 -0
- package/build/ts/surfaces/admin/components/AdminPrintAction.d.ts +6 -0
- package/build/ts/surfaces/admin/components/Avatar.d.ts +9 -0
- package/build/ts/surfaces/admin/components/Badge.d.ts +9 -0
- package/build/ts/surfaces/admin/components/Banner.d.ts +11 -0
- package/build/ts/surfaces/admin/components/Box.d.ts +14 -0
- package/build/ts/surfaces/admin/components/Button.d.ts +14 -0
- package/build/ts/surfaces/admin/components/ButtonGroup.d.ts +8 -0
- package/build/ts/surfaces/admin/components/Checkbox.d.ts +12 -1
- package/build/ts/surfaces/admin/components/Chip.d.ts +4 -2
- package/build/ts/surfaces/admin/components/Choice.d.ts +10 -2
- package/build/ts/surfaces/admin/components/ChoiceList.d.ts +12 -2
- package/build/ts/surfaces/admin/components/Clickable.d.ts +16 -4
- package/build/ts/surfaces/admin/components/ClickableChip.d.ts +11 -0
- package/build/ts/surfaces/admin/components/ColorField.d.ts +12 -0
- package/build/ts/surfaces/admin/components/ColorPicker.d.ts +9 -0
- package/build/ts/surfaces/admin/components/DateField.d.ts +11 -0
- package/build/ts/surfaces/admin/components/DatePicker.d.ts +10 -1
- package/build/ts/surfaces/admin/components/Divider.d.ts +7 -0
- package/build/ts/surfaces/admin/components/DropZone.d.ts +8 -4
- package/build/ts/surfaces/admin/components/EmailField.d.ts +12 -0
- package/build/ts/surfaces/admin/components/Form.d.ts +10 -0
- package/build/ts/surfaces/admin/components/FunctionSettings.d.ts +12 -0
- package/build/ts/surfaces/admin/components/Grid.d.ts +16 -0
- package/build/ts/surfaces/admin/components/GridItem.d.ts +15 -0
- package/build/ts/surfaces/admin/components/Heading.d.ts +8 -0
- package/build/ts/surfaces/admin/components/Icon.d.ts +6 -3
- package/build/ts/surfaces/admin/components/Image.d.ts +15 -0
- package/build/ts/surfaces/admin/components/Link.d.ts +13 -3
- package/build/ts/surfaces/admin/components/ListItem.d.ts +8 -0
- package/build/ts/surfaces/admin/components/Menu.d.ts +11 -0
- package/build/ts/surfaces/admin/components/Modal.d.ts +8 -4
- package/build/ts/surfaces/admin/components/MoneyField.d.ts +13 -0
- package/build/ts/surfaces/admin/components/NumberField.d.ts +12 -0
- package/build/ts/surfaces/admin/components/Option.d.ts +10 -2
- package/build/ts/surfaces/admin/components/OptionGroup.d.ts +10 -2
- package/build/ts/surfaces/admin/components/OrderedList.d.ts +8 -0
- package/build/ts/surfaces/admin/components/Page.d.ts +4 -2
- package/build/ts/surfaces/admin/components/Paragraph.d.ts +8 -0
- package/build/ts/surfaces/admin/components/PasswordField.d.ts +12 -0
- package/build/ts/surfaces/admin/components/QueryContainer.d.ts +8 -0
- package/build/ts/surfaces/admin/components/SearchField.d.ts +13 -1
- package/build/ts/surfaces/admin/components/Section.d.ts +9 -0
- package/build/ts/surfaces/admin/components/Select.d.ts +14 -2
- package/build/ts/surfaces/admin/components/Spinner.d.ts +7 -0
- package/build/ts/surfaces/admin/components/Stack.d.ts +16 -0
- package/build/ts/surfaces/admin/components/Switch.d.ts +12 -1
- package/build/ts/surfaces/admin/components/Table.d.ts +15 -0
- package/build/ts/surfaces/admin/components/TableBody.d.ts +8 -0
- package/build/ts/surfaces/admin/components/TableCell.d.ts +9 -0
- package/build/ts/surfaces/admin/components/TableHeader.d.ts +9 -0
- package/build/ts/surfaces/admin/components/TableHeaderRow.d.ts +8 -0
- package/build/ts/surfaces/admin/components/TableRow.d.ts +8 -0
- package/build/ts/surfaces/admin/components/Text.d.ts +19 -0
- package/build/ts/surfaces/admin/components/TextArea.d.ts +12 -0
- package/build/ts/surfaces/admin/components/TextField.d.ts +13 -0
- package/build/ts/surfaces/admin/components/Thumbnail.d.ts +9 -0
- package/build/ts/surfaces/admin/components/Tooltip.d.ts +11 -0
- package/build/ts/surfaces/admin/components/URLField.d.ts +12 -0
- package/build/ts/surfaces/admin/components/UnorderedList.d.ts +14 -0
- package/build/ts/surfaces/admin/components/shared.d.ts +267 -0
- package/build/ts/surfaces/admin/extension-targets.d.ts +8 -1
- package/build/ts/surfaces/admin/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/admin/targets/admin.app.intent.render.d.ts +61 -0
- package/build/ts/surfaces/checkout/api/address-autocomplete/format-suggestion.d.ts +2 -0
- package/build/ts/surfaces/checkout/api/address-autocomplete/format-suggestion.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/address-autocomplete/shared.d.ts +3 -0
- package/build/ts/surfaces/checkout/api/address-autocomplete/shared.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/address-autocomplete/standard.d.ts +2 -1
- package/build/ts/surfaces/checkout/api/address-autocomplete/standard.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/address-autocomplete/suggest.d.ts +2 -0
- package/build/ts/surfaces/checkout/api/address-autocomplete/suggest.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/announcement/announcement.d.ts +1 -0
- package/build/ts/surfaces/checkout/api/announcement/announcement.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts +5 -1
- package/build/ts/surfaces/checkout/api/cart-line/cart-line-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts +258 -122
- package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/docs.d.ts +33 -6
- package/build/ts/surfaces/checkout/api/docs.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/order-confirmation/order-confirmation.d.ts +12 -5
- package/build/ts/surfaces/checkout/api/order-confirmation/order-confirmation.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/payment/payment-option-item.d.ts +7 -0
- package/build/ts/surfaces/checkout/api/payment/payment-option-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-item.d.ts +3 -2
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-list.d.ts +4 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-location-list.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-point-list.d.ts +4 -1
- package/build/ts/surfaces/checkout/api/pickup/pickup-point-list.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/redeemable/redeemable.d.ts +7 -0
- package/build/ts/surfaces/checkout/api/redeemable/redeemable.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/shared.d.ts +79 -31
- package/build/ts/surfaces/checkout/api/shared.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts +6 -4
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-item.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts +18 -12
- package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts +659 -425
- package/build/ts/surfaces/checkout/api/standard/standard.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/components/Abbreviation.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Announcement.d.ts +34 -9
- package/build/ts/surfaces/checkout/components/Badge.d.ts +44 -3
- package/build/ts/surfaces/checkout/components/Banner.d.ts +60 -9
- package/build/ts/surfaces/checkout/components/Box.d.ts +50 -0
- package/build/ts/surfaces/checkout/components/Button.d.ts +10 -3
- package/build/ts/surfaces/checkout/components/Chat.d.ts +20 -0
- package/build/ts/surfaces/checkout/components/Checkbox.d.ts +10 -2
- package/build/ts/surfaces/checkout/components/Chip.d.ts +3 -3
- package/build/ts/surfaces/checkout/components/Choice.d.ts +2 -0
- package/build/ts/surfaces/checkout/components/ChoiceList.d.ts +10 -2
- package/build/ts/surfaces/checkout/components/Clickable.d.ts +31 -7
- package/build/ts/surfaces/checkout/components/ClickableChip.d.ts +15 -8
- package/build/ts/surfaces/checkout/components/ClipboardItem.d.ts +10 -2
- package/build/ts/surfaces/checkout/components/ConsentCheckbox.d.ts +16 -2
- package/build/ts/surfaces/checkout/components/ConsentPhoneField.d.ts +24 -10
- package/build/ts/surfaces/checkout/components/DateField.d.ts +24 -6
- package/build/ts/surfaces/checkout/components/DatePicker.d.ts +21 -5
- package/build/ts/surfaces/checkout/components/Details.d.ts +13 -8
- package/build/ts/surfaces/checkout/components/Divider.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/DropZone.d.ts +15 -3
- package/build/ts/surfaces/checkout/components/EmailField.d.ts +18 -10
- package/build/ts/surfaces/checkout/components/Form.d.ts +9 -1
- package/build/ts/surfaces/checkout/components/Grid.d.ts +137 -0
- package/build/ts/surfaces/checkout/components/GridItem.d.ts +55 -0
- package/build/ts/surfaces/checkout/components/Heading.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Icon.d.ts +49 -4
- package/build/ts/surfaces/checkout/components/Image.d.ts +43 -1
- package/build/ts/surfaces/checkout/components/Link.d.ts +10 -3
- package/build/ts/surfaces/checkout/components/ListItem.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Map.d.ts +68 -6
- package/build/ts/surfaces/checkout/components/MapMarker.d.ts +36 -8
- package/build/ts/surfaces/checkout/components/Modal.d.ts +52 -8
- package/build/ts/surfaces/checkout/components/MoneyField.d.ts +16 -8
- package/build/ts/surfaces/checkout/components/NumberField.d.ts +18 -10
- package/build/ts/surfaces/checkout/components/Option.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/OrderedList.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Paragraph.d.ts +12 -0
- package/build/ts/surfaces/checkout/components/PasswordField.d.ts +18 -10
- package/build/ts/surfaces/checkout/components/PaymentIcon.d.ts +17 -1
- package/build/ts/surfaces/checkout/components/PhoneField.d.ts +18 -10
- package/build/ts/surfaces/checkout/components/Popover.d.ts +39 -22
- package/build/ts/surfaces/checkout/components/PressButton.d.ts +14 -6
- package/build/ts/surfaces/checkout/components/ProductThumbnail.d.ts +26 -1
- package/build/ts/surfaces/checkout/components/Progress.d.ts +27 -0
- package/build/ts/surfaces/checkout/components/QRCode.d.ts +28 -3
- package/build/ts/surfaces/checkout/components/QueryContainer.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/ScrollBox.d.ts +55 -0
- package/build/ts/surfaces/checkout/components/Section.d.ts +4 -0
- package/build/ts/surfaces/checkout/components/Select.d.ts +14 -6
- package/build/ts/surfaces/checkout/components/Sheet.d.ts +40 -13
- package/build/ts/surfaces/checkout/components/SkeletonParagraph.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Spinner.d.ts +16 -0
- package/build/ts/surfaces/checkout/components/Stack.d.ts +110 -0
- package/build/ts/surfaces/checkout/components/Summary.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Switch.d.ts +10 -2
- package/build/ts/surfaces/checkout/components/Text.d.ts +18 -1
- package/build/ts/surfaces/checkout/components/TextArea.d.ts +16 -8
- package/build/ts/surfaces/checkout/components/TextField.d.ts +18 -10
- package/build/ts/surfaces/checkout/components/Time.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/Tooltip.d.ts +21 -2
- package/build/ts/surfaces/checkout/components/UnorderedList.d.ts +1 -0
- package/build/ts/surfaces/checkout/components/UrlField.d.ts +18 -10
- package/build/ts/surfaces/checkout/components/components-shared.d.ts +728 -718
- package/build/ts/surfaces/checkout/components/components.d.ts +575 -297
- package/build/ts/surfaces/checkout/extension-targets.d.ts +13 -0
- package/build/ts/surfaces/checkout/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/globals.d.ts +1 -0
- package/build/ts/surfaces/checkout/globals.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/api.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/api.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/app-metafields.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/app-metafields.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/attributes.d.ts +3 -0
- package/build/ts/surfaces/checkout/preact/attributes.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/billing-address.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/billing-address.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/buyer-identity.d.ts +4 -0
- package/build/ts/surfaces/checkout/preact/buyer-identity.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/buyer-journey.d.ts +5 -0
- package/build/ts/surfaces/checkout/preact/buyer-journey.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/capabilities.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/capabilities.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/cart-line-target.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/cart-line-target.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/cart-lines.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/cart-lines.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/checkout-settings.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/checkout-settings.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/checkout-token.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/checkout-token.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/cost.d.ts +4 -0
- package/build/ts/surfaces/checkout/preact/cost.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/country.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/country.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/currency.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/currency.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/customer-privacy.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/customer-privacy.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/delivery-group-list-target.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/delivery-group-list-target.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/delivery-group-target.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/delivery-group-target.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/delivery-group.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/delivery-group.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/delivery-groups.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/delivery-groups.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/delivery-selection-groups.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/delivery-selection-groups.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/discounts.d.ts +3 -0
- package/build/ts/surfaces/checkout/preact/discounts.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/extension-editor.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/extension-editor.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/extension-language.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/extension-language.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/extension.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/extension.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/gift-cards.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/gift-cards.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/instructions.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/instructions.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/language.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/language.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/localized-fields.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/localized-fields.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/market.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/market.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/metafields.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/metafields.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/note.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/note.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/payment-method.d.ts +3 -0
- package/build/ts/surfaces/checkout/preact/payment-method.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/payment-options.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/payment-options.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/pickup-location-option-target.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/pickup-location-option-target.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/redeemable.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/redeemable.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/session-token.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/session-token.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/settings.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/settings.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/shipping-address.d.ts +2 -0
- package/build/ts/surfaces/checkout/preact/shipping-address.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/shipping-option-target.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/shipping-option-target.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/shop.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/shop.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/storage.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/storage.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/subscription.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/subscription.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/target.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/target.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/timezone.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/timezone.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/preact/translate.d.ts +1 -0
- package/build/ts/surfaces/checkout/preact/translate.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/shared.d.ts +11 -19
- package/build/ts/surfaces/checkout/shared.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/style/style.d.ts +1 -0
- package/build/ts/surfaces/checkout/style/style.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/style/types.d.ts +20 -8
- package/build/ts/surfaces/checkout/style/types.d.ts.map +1 -1
- package/build/ts/surfaces/checkout/targets/purchase.cart-line-item.line-components.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.actions.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.block.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-item.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.cart-line-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.chat.render.d.ts +2 -1
- package/build/ts/surfaces/checkout/targets/purchase.checkout.contact.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.delivery-address.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.footer.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.gift-card.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.header.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-method-list.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.action-required.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.details.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.payment-option-item.hosted-fields.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-list.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-location-option-item.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.pickup-point-list.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.reductions.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.details.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-item.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.checkout.shipping-option-list.render-before.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.announcement.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.block.render.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-item.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.cart-line-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.chat.render.d.ts +2 -1
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.customer-information.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.footer.render-after.d.ts +1 -0
- package/build/ts/surfaces/checkout/targets/purchase.thank-you.header.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts +3 -0
- package/build/ts/surfaces/customer-account/api/cart-line/cart-line-item.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/docs.d.ts +239 -17
- package/build/ts/surfaces/customer-account/api/docs.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts +453 -296
- package/build/ts/surfaces/customer-account/api/order-status/order-status.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/shared.d.ts +209 -138
- package/build/ts/surfaces/customer-account/api/shared.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts +84 -68
- package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/Abbreviation.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Announcement.d.ts +34 -9
- package/build/ts/surfaces/customer-account/components/Avatar.d.ts +43 -15
- package/build/ts/surfaces/customer-account/components/Badge.d.ts +44 -3
- package/build/ts/surfaces/customer-account/components/Banner.d.ts +60 -9
- package/build/ts/surfaces/customer-account/components/Box.d.ts +50 -0
- package/build/ts/surfaces/customer-account/components/Button.d.ts +10 -3
- package/build/ts/surfaces/customer-account/components/ButtonGroup.d.ts +3 -3
- package/build/ts/surfaces/customer-account/components/Chat.d.ts +20 -0
- package/build/ts/surfaces/customer-account/components/Checkbox.d.ts +10 -2
- package/build/ts/surfaces/customer-account/components/Chip.d.ts +3 -3
- package/build/ts/surfaces/customer-account/components/Choice.d.ts +2 -0
- package/build/ts/surfaces/customer-account/components/ChoiceList.d.ts +10 -2
- package/build/ts/surfaces/customer-account/components/Clickable.d.ts +31 -7
- package/build/ts/surfaces/customer-account/components/ClickableChip.d.ts +15 -8
- package/build/ts/surfaces/customer-account/components/ClipboardItem.d.ts +10 -2
- package/build/ts/surfaces/customer-account/components/ConsentCheckbox.d.ts +16 -2
- package/build/ts/surfaces/customer-account/components/ConsentPhoneField.d.ts +24 -10
- package/build/ts/surfaces/customer-account/components/CustomerAccountAction.d.ts +3 -3
- package/build/ts/surfaces/customer-account/components/DateField.d.ts +24 -6
- package/build/ts/surfaces/customer-account/components/DatePicker.d.ts +21 -5
- package/build/ts/surfaces/customer-account/components/Details.d.ts +13 -8
- package/build/ts/surfaces/customer-account/components/Divider.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/DropZone.d.ts +15 -3
- package/build/ts/surfaces/customer-account/components/EmailField.d.ts +18 -10
- package/build/ts/surfaces/customer-account/components/Form.d.ts +9 -1
- package/build/ts/surfaces/customer-account/components/Grid.d.ts +137 -0
- package/build/ts/surfaces/customer-account/components/GridItem.d.ts +55 -0
- package/build/ts/surfaces/customer-account/components/Heading.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Icon.d.ts +49 -4
- package/build/ts/surfaces/customer-account/components/Image.d.ts +43 -1
- package/build/ts/surfaces/customer-account/components/ImageGroup.d.ts +7 -2
- package/build/ts/surfaces/customer-account/components/Link.d.ts +10 -3
- package/build/ts/surfaces/customer-account/components/ListItem.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Map.d.ts +68 -6
- package/build/ts/surfaces/customer-account/components/MapMarker.d.ts +36 -8
- package/build/ts/surfaces/customer-account/components/Menu.d.ts +1 -1
- package/build/ts/surfaces/customer-account/components/Modal.d.ts +52 -8
- package/build/ts/surfaces/customer-account/components/MoneyField.d.ts +16 -8
- package/build/ts/surfaces/customer-account/components/NumberField.d.ts +18 -10
- package/build/ts/surfaces/customer-account/components/Option.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/OrderedList.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Page.d.ts +5 -5
- package/build/ts/surfaces/customer-account/components/Paragraph.d.ts +12 -0
- package/build/ts/surfaces/customer-account/components/PasswordField.d.ts +18 -10
- package/build/ts/surfaces/customer-account/components/PaymentIcon.d.ts +17 -1
- package/build/ts/surfaces/customer-account/components/PhoneField.d.ts +18 -10
- package/build/ts/surfaces/customer-account/components/Popover.d.ts +39 -22
- package/build/ts/surfaces/customer-account/components/PressButton.d.ts +14 -6
- package/build/ts/surfaces/customer-account/components/ProductThumbnail.d.ts +26 -1
- package/build/ts/surfaces/customer-account/components/Progress.d.ts +27 -0
- package/build/ts/surfaces/customer-account/components/QRCode.d.ts +28 -3
- package/build/ts/surfaces/customer-account/components/QueryContainer.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/ScrollBox.d.ts +55 -0
- package/build/ts/surfaces/customer-account/components/Section.d.ts +4 -0
- package/build/ts/surfaces/customer-account/components/Select.d.ts +14 -6
- package/build/ts/surfaces/customer-account/components/Sheet.d.ts +40 -13
- package/build/ts/surfaces/customer-account/components/SkeletonParagraph.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Spinner.d.ts +16 -0
- package/build/ts/surfaces/customer-account/components/Stack.d.ts +110 -0
- package/build/ts/surfaces/customer-account/components/Summary.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Switch.d.ts +10 -2
- package/build/ts/surfaces/customer-account/components/Text.d.ts +18 -1
- package/build/ts/surfaces/customer-account/components/TextArea.d.ts +16 -8
- package/build/ts/surfaces/customer-account/components/TextField.d.ts +18 -10
- package/build/ts/surfaces/customer-account/components/Time.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/Tooltip.d.ts +21 -2
- package/build/ts/surfaces/customer-account/components/UnorderedList.d.ts +1 -0
- package/build/ts/surfaces/customer-account/components/UrlField.d.ts +18 -10
- package/build/ts/surfaces/customer-account/components/components-shared.d.ts +728 -718
- package/build/ts/surfaces/customer-account/components/components.d.ts +575 -297
- package/build/ts/surfaces/customer-account/components/shared.d.ts +23 -2
- package/build/ts/surfaces/customer-account/components/shared.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/components/shared.ts +23 -5
- package/build/ts/surfaces/customer-account/extension-targets.d.ts +8 -0
- package/build/ts/surfaces/customer-account/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/customer-account/targets/customer-account.footer.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-index.announcement.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-index.block.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.announcement.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.block.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-item.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.cart-line-list.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.customer-information.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.fulfillment-details.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.payment-details.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.return-details.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order-status.unfulfilled-items.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order.action.menu-item.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order.action.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.order.page.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.page.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.addresses.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.announcement.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.block.render.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-details.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-addresses.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-payment.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.company-location-staff.render-after.d.ts +1 -0
- package/build/ts/surfaces/customer-account/targets/customer-account.profile.payment.render-after.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/api/action-api/action-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/action-target-api/action-target-api.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/api/action-target-api/action-target-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/camera-api/camera-api.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/api/camera-api/camera-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/api/cart-api/cart-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts +9 -0
- package/build/ts/surfaces/point-of-sale/api/connectivity-api/connectivity-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/customer-api/customer-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/device-api/device-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/device-api/device-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/draft-order-api/draft-order-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/locale-api/locale-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts +9 -0
- package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/api/order-api/order-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/api/print-api/print-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/product-api/product-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts +10 -0
- package/build/ts/surfaces/point-of-sale/api/product-search-api/product-search-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts +12 -1
- package/build/ts/surfaces/point-of-sale/api/scanner-api/scanner-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/session-api/session-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/api/standard/standard-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/api/storage-api/storage-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/api/toast-api/toast-api.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/Badge.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/Banner.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Box.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Button.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Choice.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Clickable.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/DateField.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/DatePicker.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/DateSpinner.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Divider.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/EmailField.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/components/Embed.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/EmptyState.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Heading.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/Icon.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Image.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/Link.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Modal.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/NumberField.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Page.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/PosBlock.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/QrCode.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/ScrollBox.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/SearchField.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Section.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Spinner.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Stack.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Switch.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Tab.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/TabList.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/TabPanel.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/Tabs.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Text.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/components/TextArea.d.ts +8 -0
- package/build/ts/surfaces/point-of-sale/components/TextField.d.ts +7 -0
- package/build/ts/surfaces/point-of-sale/components/Tile.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/TimeField.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/TimePicker.d.ts +6 -0
- package/build/ts/surfaces/point-of-sale/components/components-shared.d.ts +135 -0
- package/build/ts/surfaces/point-of-sale/components/targets/ActionExtensionComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/ActionExtensionComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/BasicComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/BasicComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/BlockExtensionComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/BlockExtensionComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/ReceiptComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/SmartGridComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/SmartGridComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/components/targets/StandardComponents.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/BaseApi.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts +3 -2
- package/build/ts/surfaces/point-of-sale/event/data/BaseData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/CartUpdateEventData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/event/data/CashTrackingSessionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/ExchangeTransactionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/ReprintReceiptData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/ReturnTransactionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/data/SaleTransactionData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/event/data/TransactionCompleteData.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/event/output/BaseOutput.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts +18 -0
- package/build/ts/surfaces/point-of-sale/extension-targets.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/base-transaction-complete.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/cart.d.ts +13 -0
- package/build/ts/surfaces/point-of-sale/types/cart.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/country-code.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/country-code.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/device.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/device.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/direct-api-request-body.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/discount-allocation.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/money.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/types/money.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/multiple-resource-result.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/order.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/types/order.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/paginated-result.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/payment.d.ts +2 -0
- package/build/ts/surfaces/point-of-sale/types/payment.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/product.d.ts +5 -0
- package/build/ts/surfaces/point-of-sale/types/product.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/session.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/session.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts +3 -0
- package/build/ts/surfaces/point-of-sale/types/shipping-line.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/storage.d.ts +4 -0
- package/build/ts/surfaces/point-of-sale/types/storage.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/tax-line.d.ts.map +1 -1
- package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts +1 -0
- package/build/ts/surfaces/point-of-sale/types/transaction-type.d.ts.map +1 -1
- package/build/tsconfig.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/src/shared.ts +32 -12
- package/src/surfaces/admin/api/action/action.ts +1 -0
- package/src/surfaces/admin/api/block/block.ts +2 -0
- package/src/surfaces/admin/api/checkout-rules/launch-options.ts +7 -3
- package/src/surfaces/admin/api/checkout-rules/metafields.ts +13 -6
- package/src/surfaces/admin/api/checkout-rules/validation-settings.ts +1 -0
- package/src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts +3 -0
- package/src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts +1 -0
- package/src/surfaces/admin/api/discount-function-settings/launch-options.ts +7 -2
- package/src/surfaces/admin/api/discount-function-settings/metafields.ts +13 -6
- package/src/surfaces/admin/api/generated/generated.ts +76 -0
- package/src/surfaces/admin/api/intents/intent-render.ts +26 -0
- package/src/surfaces/admin/api/intents/intents.ts +49 -8
- package/src/surfaces/admin/api/order-routing-rule/data.ts +5 -2
- package/src/surfaces/admin/api/order-routing-rule/metafields.ts +8 -3
- package/src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts +1 -0
- package/src/surfaces/admin/api/picker/picker.ts +15 -6
- package/src/surfaces/admin/api/print-action/print-action.ts +1 -0
- package/src/surfaces/admin/api/product-configuration/product-details-configuration.ts +4 -1
- package/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts +4 -1
- package/src/surfaces/admin/api/purchase-options-card-action.ts +1 -0
- package/src/surfaces/admin/api/resource-picker/resource-picker.ts +36 -17
- package/src/surfaces/admin/api/shared.ts +2 -0
- package/src/surfaces/admin/api/standard/standard-rendering.ts +3 -0
- package/src/surfaces/admin/api/standard/standard.ts +4 -1
- package/src/surfaces/admin/api/standard/storage.ts +4 -0
- package/src/surfaces/admin/api.ts +7 -0
- package/src/surfaces/admin/components/AdminAction.d.ts +6 -0
- package/src/surfaces/admin/components/AdminBlock.d.ts +6 -0
- package/src/surfaces/admin/components/AdminPrintAction.d.ts +6 -0
- package/src/surfaces/admin/components/Avatar.d.ts +9 -0
- package/src/surfaces/admin/components/Badge.d.ts +9 -0
- package/src/surfaces/admin/components/Banner.d.ts +11 -0
- package/src/surfaces/admin/components/Box.d.ts +14 -0
- package/src/surfaces/admin/components/Button.d.ts +14 -0
- package/src/surfaces/admin/components/ButtonGroup.d.ts +8 -0
- package/src/surfaces/admin/components/Checkbox.d.ts +12 -1
- package/src/surfaces/admin/components/Chip.d.ts +4 -2
- package/src/surfaces/admin/components/Choice.d.ts +10 -2
- package/src/surfaces/admin/components/ChoiceList.d.ts +12 -2
- package/src/surfaces/admin/components/Clickable.d.ts +16 -4
- package/src/surfaces/admin/components/ClickableChip.d.ts +11 -0
- package/src/surfaces/admin/components/ColorField.d.ts +12 -0
- package/src/surfaces/admin/components/ColorPicker.d.ts +9 -0
- package/src/surfaces/admin/components/DateField.d.ts +11 -0
- package/src/surfaces/admin/components/DatePicker.d.ts +10 -1
- package/src/surfaces/admin/components/Divider.d.ts +7 -0
- package/src/surfaces/admin/components/DropZone.d.ts +8 -4
- package/src/surfaces/admin/components/EmailField.d.ts +12 -0
- package/src/surfaces/admin/components/Form.d.ts +10 -0
- package/src/surfaces/admin/components/FunctionSettings.d.ts +12 -0
- package/src/surfaces/admin/components/Grid.d.ts +16 -0
- package/src/surfaces/admin/components/GridItem.d.ts +15 -0
- package/src/surfaces/admin/components/Heading.d.ts +8 -0
- package/src/surfaces/admin/components/Icon.d.ts +6 -3
- package/src/surfaces/admin/components/Image.d.ts +15 -0
- package/src/surfaces/admin/components/Link.d.ts +13 -3
- package/src/surfaces/admin/components/ListItem.d.ts +8 -0
- package/src/surfaces/admin/components/Menu.d.ts +11 -0
- package/src/surfaces/admin/components/Modal.d.ts +8 -4
- package/src/surfaces/admin/components/MoneyField.d.ts +13 -0
- package/src/surfaces/admin/components/NumberField.d.ts +12 -0
- package/src/surfaces/admin/components/Option.d.ts +10 -2
- package/src/surfaces/admin/components/OptionGroup.d.ts +10 -2
- package/src/surfaces/admin/components/OrderedList.d.ts +8 -0
- package/src/surfaces/admin/components/Page.d.ts +4 -2
- package/src/surfaces/admin/components/Paragraph.d.ts +8 -0
- package/src/surfaces/admin/components/PasswordField.d.ts +12 -0
- package/src/surfaces/admin/components/QueryContainer.d.ts +8 -0
- package/src/surfaces/admin/components/SearchField.d.ts +13 -1
- package/src/surfaces/admin/components/Section.d.ts +9 -0
- package/src/surfaces/admin/components/Select.d.ts +14 -2
- package/src/surfaces/admin/components/Spinner.d.ts +7 -0
- package/src/surfaces/admin/components/Stack.d.ts +16 -0
- package/src/surfaces/admin/components/Switch.d.ts +12 -1
- package/src/surfaces/admin/components/Table.d.ts +15 -0
- package/src/surfaces/admin/components/TableBody.d.ts +8 -0
- package/src/surfaces/admin/components/TableCell.d.ts +9 -0
- package/src/surfaces/admin/components/TableHeader.d.ts +9 -0
- package/src/surfaces/admin/components/TableHeaderRow.d.ts +8 -0
- package/src/surfaces/admin/components/TableRow.d.ts +8 -0
- package/src/surfaces/admin/components/Text.d.ts +19 -0
- package/src/surfaces/admin/components/TextArea.d.ts +12 -0
- package/src/surfaces/admin/components/TextField.d.ts +13 -0
- package/src/surfaces/admin/components/Thumbnail.d.ts +9 -0
- package/src/surfaces/admin/components/Tooltip.d.ts +11 -0
- package/src/surfaces/admin/components/URLField.d.ts +12 -0
- package/src/surfaces/admin/components/UnorderedList.d.ts +14 -0
- package/src/surfaces/admin/components/shared.d.ts +267 -0
- package/src/surfaces/admin/components.d.ts +700 -0
- package/src/surfaces/admin/extension-targets.ts +12 -0
- package/src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts +2 -0
- package/src/surfaces/checkout/api/address-autocomplete/shared.ts +3 -0
- package/src/surfaces/checkout/api/address-autocomplete/standard.ts +2 -1
- package/src/surfaces/checkout/api/address-autocomplete/suggest.ts +2 -0
- package/src/surfaces/checkout/api/announcement/announcement.ts +1 -0
- package/src/surfaces/checkout/api/cart-line/cart-line-item.ts +5 -1
- package/src/surfaces/checkout/api/checkout/checkout.ts +258 -122
- package/src/surfaces/checkout/api/docs.ts +34 -1
- package/src/surfaces/checkout/api/order-confirmation/order-confirmation.ts +12 -5
- package/src/surfaces/checkout/api/payment/payment-option-item.ts +7 -0
- package/src/surfaces/checkout/api/pickup/pickup-location-item.ts +3 -2
- package/src/surfaces/checkout/api/pickup/pickup-location-list.ts +4 -1
- package/src/surfaces/checkout/api/pickup/pickup-point-list.ts +4 -1
- package/src/surfaces/checkout/api/redeemable/redeemable.ts +7 -0
- package/src/surfaces/checkout/api/shared.ts +79 -31
- package/src/surfaces/checkout/api/shipping/shipping-option-item.ts +6 -4
- package/src/surfaces/checkout/api/shipping/shipping-option-list.ts +18 -12
- package/src/surfaces/checkout/api/standard/standard.ts +661 -425
- package/src/surfaces/checkout/components/Abbreviation.d.ts +1 -0
- package/src/surfaces/checkout/components/Announcement.d.ts +34 -9
- package/src/surfaces/checkout/components/Badge.d.ts +44 -3
- package/src/surfaces/checkout/components/Banner.d.ts +60 -9
- package/src/surfaces/checkout/components/Box.d.ts +50 -0
- package/src/surfaces/checkout/components/Button.d.ts +10 -3
- package/src/surfaces/checkout/components/Chat.d.ts +20 -0
- package/src/surfaces/checkout/components/Checkbox.d.ts +10 -2
- package/src/surfaces/checkout/components/Chip.d.ts +3 -3
- package/src/surfaces/checkout/components/Choice.d.ts +2 -0
- package/src/surfaces/checkout/components/ChoiceList.d.ts +10 -2
- package/src/surfaces/checkout/components/Clickable.d.ts +31 -7
- package/src/surfaces/checkout/components/ClickableChip.d.ts +15 -8
- package/src/surfaces/checkout/components/ClipboardItem.d.ts +10 -2
- package/src/surfaces/checkout/components/ConsentCheckbox.d.ts +16 -2
- package/src/surfaces/checkout/components/ConsentPhoneField.d.ts +24 -10
- package/src/surfaces/checkout/components/DateField.d.ts +24 -6
- package/src/surfaces/checkout/components/DatePicker.d.ts +21 -5
- package/src/surfaces/checkout/components/Details.d.ts +13 -8
- package/src/surfaces/checkout/components/Divider.d.ts +1 -0
- package/src/surfaces/checkout/components/DropZone.d.ts +15 -3
- package/src/surfaces/checkout/components/EmailField.d.ts +18 -10
- package/src/surfaces/checkout/components/Form.d.ts +9 -1
- package/src/surfaces/checkout/components/Grid.d.ts +137 -0
- package/src/surfaces/checkout/components/GridItem.d.ts +55 -0
- package/src/surfaces/checkout/components/Heading.d.ts +1 -0
- package/src/surfaces/checkout/components/Icon.d.ts +49 -4
- package/src/surfaces/checkout/components/Image.d.ts +43 -1
- package/src/surfaces/checkout/components/Link.d.ts +10 -3
- package/src/surfaces/checkout/components/ListItem.d.ts +1 -0
- package/src/surfaces/checkout/components/Map.d.ts +68 -6
- package/src/surfaces/checkout/components/MapMarker.d.ts +36 -8
- package/src/surfaces/checkout/components/Modal.d.ts +52 -8
- package/src/surfaces/checkout/components/MoneyField.d.ts +16 -8
- package/src/surfaces/checkout/components/NumberField.d.ts +18 -10
- package/src/surfaces/checkout/components/Option.d.ts +1 -0
- package/src/surfaces/checkout/components/OrderedList.d.ts +1 -0
- package/src/surfaces/checkout/components/Paragraph.d.ts +12 -0
- package/src/surfaces/checkout/components/PasswordField.d.ts +18 -10
- package/src/surfaces/checkout/components/PaymentIcon.d.ts +17 -1
- package/src/surfaces/checkout/components/PhoneField.d.ts +18 -10
- package/src/surfaces/checkout/components/Popover.d.ts +39 -22
- package/src/surfaces/checkout/components/PressButton.d.ts +14 -6
- package/src/surfaces/checkout/components/ProductThumbnail.d.ts +26 -1
- package/src/surfaces/checkout/components/Progress.d.ts +27 -0
- package/src/surfaces/checkout/components/QRCode.d.ts +28 -3
- package/src/surfaces/checkout/components/QueryContainer.d.ts +1 -0
- package/src/surfaces/checkout/components/ScrollBox.d.ts +55 -0
- package/src/surfaces/checkout/components/Section.d.ts +4 -0
- package/src/surfaces/checkout/components/Select.d.ts +14 -6
- package/src/surfaces/checkout/components/Sheet.d.ts +40 -13
- package/src/surfaces/checkout/components/SkeletonParagraph.d.ts +1 -0
- package/src/surfaces/checkout/components/Spinner.d.ts +16 -0
- package/src/surfaces/checkout/components/Stack.d.ts +110 -0
- package/src/surfaces/checkout/components/Summary.d.ts +1 -0
- package/src/surfaces/checkout/components/Switch.d.ts +10 -2
- package/src/surfaces/checkout/components/Text.d.ts +18 -1
- package/src/surfaces/checkout/components/TextArea.d.ts +16 -8
- package/src/surfaces/checkout/components/TextField.d.ts +18 -10
- package/src/surfaces/checkout/components/Time.d.ts +1 -0
- package/src/surfaces/checkout/components/Tooltip.d.ts +21 -2
- package/src/surfaces/checkout/components/UnorderedList.d.ts +1 -0
- package/src/surfaces/checkout/components/UrlField.d.ts +18 -10
- package/src/surfaces/checkout/components/components-shared.d.ts +728 -718
- package/src/surfaces/checkout/components/components.d.ts +575 -297
- package/src/surfaces/checkout/extension-targets.ts +13 -0
- package/src/surfaces/checkout/globals.ts +1 -0
- package/src/surfaces/checkout/preact/api.ts +2 -0
- package/src/surfaces/checkout/preact/app-metafields.ts +1 -0
- package/src/surfaces/checkout/preact/attributes.ts +3 -0
- package/src/surfaces/checkout/preact/billing-address.ts +1 -0
- package/src/surfaces/checkout/preact/buyer-identity.ts +4 -0
- package/src/surfaces/checkout/preact/buyer-journey.ts +5 -0
- package/src/surfaces/checkout/preact/capabilities.ts +2 -0
- package/src/surfaces/checkout/preact/cart-line-target.ts +1 -0
- package/src/surfaces/checkout/preact/cart-lines.ts +2 -0
- package/src/surfaces/checkout/preact/checkout-settings.ts +1 -0
- package/src/surfaces/checkout/preact/checkout-token.ts +1 -0
- package/src/surfaces/checkout/preact/cost.ts +4 -0
- package/src/surfaces/checkout/preact/country.ts +1 -0
- package/src/surfaces/checkout/preact/currency.ts +1 -0
- package/src/surfaces/checkout/preact/customer-privacy.ts +1 -0
- package/src/surfaces/checkout/preact/delivery-group-list-target.ts +1 -0
- package/src/surfaces/checkout/preact/delivery-group-target.ts +1 -0
- package/src/surfaces/checkout/preact/delivery-group.ts +1 -0
- package/src/surfaces/checkout/preact/delivery-groups.ts +1 -0
- package/src/surfaces/checkout/preact/delivery-selection-groups.ts +1 -0
- package/src/surfaces/checkout/preact/discounts.ts +3 -0
- package/src/surfaces/checkout/preact/extension-editor.ts +1 -0
- package/src/surfaces/checkout/preact/extension-language.ts +1 -0
- package/src/surfaces/checkout/preact/extension.ts +2 -0
- package/src/surfaces/checkout/preact/gift-cards.ts +2 -0
- package/src/surfaces/checkout/preact/instructions.ts +1 -0
- package/src/surfaces/checkout/preact/language.ts +1 -0
- package/src/surfaces/checkout/preact/localized-fields.ts +2 -0
- package/src/surfaces/checkout/preact/market.ts +1 -0
- package/src/surfaces/checkout/preact/metafields.ts +1 -0
- package/src/surfaces/checkout/preact/note.ts +2 -0
- package/src/surfaces/checkout/preact/payment-method.ts +3 -0
- package/src/surfaces/checkout/preact/payment-options.ts +2 -0
- package/src/surfaces/checkout/preact/pickup-location-option-target.ts +1 -0
- package/src/surfaces/checkout/preact/redeemable.ts +1 -0
- package/src/surfaces/checkout/preact/session-token.ts +1 -0
- package/src/surfaces/checkout/preact/settings.ts +1 -0
- package/src/surfaces/checkout/preact/shipping-address.ts +2 -0
- package/src/surfaces/checkout/preact/shipping-option-target.ts +1 -0
- package/src/surfaces/checkout/preact/shop.ts +1 -0
- package/src/surfaces/checkout/preact/storage.ts +1 -0
- package/src/surfaces/checkout/preact/subscription.ts +1 -0
- package/src/surfaces/checkout/preact/target.ts +1 -0
- package/src/surfaces/checkout/preact/timezone.ts +1 -0
- package/src/surfaces/checkout/preact/translate.ts +1 -0
- package/src/surfaces/checkout/shared.ts +11 -21
- package/src/surfaces/checkout/style/style.ts +1 -0
- package/src/surfaces/checkout/style/types.ts +20 -7
- package/src/surfaces/customer-account/api/cart-line/cart-line-item.ts +3 -0
- package/src/surfaces/customer-account/api/docs.ts +244 -19
- package/src/surfaces/customer-account/api/order-status/order-status.ts +460 -296
- package/src/surfaces/customer-account/api/shared.ts +210 -138
- package/src/surfaces/customer-account/api/standard-api/standard-api.ts +84 -68
- package/src/surfaces/customer-account/components/Avatar.d.ts +43 -15
- package/src/surfaces/customer-account/components/ButtonGroup.d.ts +3 -3
- package/src/surfaces/customer-account/components/CustomerAccountAction.d.ts +3 -3
- package/src/surfaces/customer-account/components/ImageGroup.d.ts +7 -2
- package/src/surfaces/customer-account/components/Menu.d.ts +1 -1
- package/src/surfaces/customer-account/components/Page.d.ts +5 -5
- package/src/surfaces/customer-account/components/Section.d.ts +3 -7
- package/src/surfaces/customer-account/components/shared.ts +23 -5
- package/src/surfaces/customer-account/components.d.ts +93 -0
- package/src/surfaces/customer-account/extension-targets.ts +8 -0
- package/src/surfaces/point-of-sale/api/action-api/action-api.ts +4 -0
- package/src/surfaces/point-of-sale/api/action-target-api/action-target-api.ts +3 -0
- package/src/surfaces/point-of-sale/api/camera-api/camera-api.ts +4 -0
- package/src/surfaces/point-of-sale/api/cart-api/cart-api.ts +7 -0
- package/src/surfaces/point-of-sale/api/cart-line-item-api/cart-line-item-api.ts +1 -0
- package/src/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.ts +2 -0
- package/src/surfaces/point-of-sale/api/connectivity-api/connectivity-api.ts +9 -0
- package/src/surfaces/point-of-sale/api/customer-api/customer-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/device-api/device-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/draft-order-api/draft-order-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/locale-api/locale-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts +9 -0
- package/src/surfaces/point-of-sale/api/order-api/order-api.ts +2 -0
- package/src/surfaces/point-of-sale/api/pin-pad-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/print-api/print-api.ts +2 -0
- package/src/surfaces/point-of-sale/api/product-api/product-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/product-search-api/product-search-api.ts +10 -0
- package/src/surfaces/point-of-sale/api/scanner-api/scanner-api.ts +12 -1
- package/src/surfaces/point-of-sale/api/session-api/session-api.ts +5 -0
- package/src/surfaces/point-of-sale/api/standard/standard-api.ts +3 -0
- package/src/surfaces/point-of-sale/api/storage-api/storage-api.ts +1 -0
- package/src/surfaces/point-of-sale/api/toast-api/toast-api.ts +5 -0
- package/src/surfaces/point-of-sale/components/Badge.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/Banner.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Box.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Button.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Choice.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/ChoiceList.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Clickable.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/DateField.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/DatePicker.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/DateSpinner.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Divider.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/EmailField.d.ts +8 -0
- package/src/surfaces/point-of-sale/components/Embed.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/EmptyState.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Heading.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/Icon.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Image.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/Link.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Modal.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/NumberField.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Page.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/PosBlock.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/QrCode.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/ScrollBox.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/SearchField.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Section.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Spinner.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Stack.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Switch.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Tab.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/TabList.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/TabPanel.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/Tabs.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Text.d.ts +5 -0
- package/src/surfaces/point-of-sale/components/TextArea.d.ts +8 -0
- package/src/surfaces/point-of-sale/components/TextField.d.ts +7 -0
- package/src/surfaces/point-of-sale/components/Tile.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/TimeField.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/TimePicker.d.ts +6 -0
- package/src/surfaces/point-of-sale/components/components-shared.d.ts +135 -0
- package/src/surfaces/point-of-sale/components/targets/ActionExtensionComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components/targets/BasicComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components/targets/BlockExtensionComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components/targets/ReceiptComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components/targets/SmartGridComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components/targets/StandardComponents.ts +3 -0
- package/src/surfaces/point-of-sale/components.d.ts +286 -0
- package/src/surfaces/point-of-sale/event/data/BaseApi.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/BaseData.ts +7 -2
- package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts +2 -0
- package/src/surfaces/point-of-sale/event/data/ExchangeTransactionData.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/ReprintReceiptData.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/ReturnTransactionData.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/SaleTransactionData.ts +1 -0
- package/src/surfaces/point-of-sale/event/data/TransactionCompleteData.ts +2 -0
- package/src/surfaces/point-of-sale/event/output/BaseOutput.ts +1 -0
- package/src/surfaces/point-of-sale/extension-targets.ts +18 -0
- package/src/surfaces/point-of-sale/types/base-transaction-complete.ts +1 -0
- package/src/surfaces/point-of-sale/types/cart.ts +13 -0
- package/src/surfaces/point-of-sale/types/country-code.ts +1 -0
- package/src/surfaces/point-of-sale/types/device.ts +1 -0
- package/src/surfaces/point-of-sale/types/direct-api-request-body.ts +1 -0
- package/src/surfaces/point-of-sale/types/discount-allocation.ts +1 -0
- package/src/surfaces/point-of-sale/types/money.ts +2 -0
- package/src/surfaces/point-of-sale/types/multiple-resource-result.ts +1 -0
- package/src/surfaces/point-of-sale/types/order.ts +2 -0
- package/src/surfaces/point-of-sale/types/paginated-result.ts +1 -0
- package/src/surfaces/point-of-sale/types/payment.ts +2 -0
- package/src/surfaces/point-of-sale/types/pin-pad.ts +5 -0
- package/src/surfaces/point-of-sale/types/product.ts +5 -0
- package/src/surfaces/point-of-sale/types/session.ts +1 -0
- package/src/surfaces/point-of-sale/types/shipping-line.ts +3 -0
- package/src/surfaces/point-of-sale/types/storage.ts +4 -0
- package/src/surfaces/point-of-sale/types/tax-line.ts +1 -0
- package/src/surfaces/point-of-sale/types/transaction-type.ts +1 -0
|
@@ -14,23 +14,21 @@ export type ComponentChildren = any;
|
|
|
14
14
|
export type StringChildren = string;
|
|
15
15
|
export interface GlobalProps {
|
|
16
16
|
/**
|
|
17
|
-
* A unique identifier for the element.
|
|
17
|
+
* A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.
|
|
18
18
|
*/
|
|
19
19
|
id?: string;
|
|
20
20
|
}
|
|
21
21
|
interface AbbreviationProps$1 extends GlobalProps {
|
|
22
22
|
/**
|
|
23
|
-
* The content
|
|
23
|
+
* The abbreviated text content displayed within the abbreviation component. Pair with the `title` attribute to provide the full expansion for accessibility.
|
|
24
24
|
*/
|
|
25
25
|
children?: ComponentChildren;
|
|
26
26
|
/**
|
|
27
|
-
* Defines the full expansion of the abbreviation or acronym.
|
|
27
|
+
* Defines the full expansion of the abbreviation or acronym. Helps user agents and users understand the meaning of the abbreviated text.
|
|
28
28
|
*
|
|
29
|
-
*
|
|
29
|
+
* Learn more about the [abbreviation element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr).
|
|
30
30
|
*
|
|
31
31
|
* @default ''
|
|
32
|
-
*
|
|
33
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr
|
|
34
32
|
*/
|
|
35
33
|
title?: string;
|
|
36
34
|
}
|
|
@@ -46,19 +44,19 @@ export interface ActionSlots {
|
|
|
46
44
|
}
|
|
47
45
|
export interface BaseOverlayProps {
|
|
48
46
|
/**
|
|
49
|
-
*
|
|
47
|
+
* A callback fired immediately after the overlay is shown.
|
|
50
48
|
*/
|
|
51
49
|
onShow?: (event: Event) => void;
|
|
52
50
|
/**
|
|
53
|
-
*
|
|
51
|
+
* A callback fired when the overlay is shown, after any show animations have completed.
|
|
54
52
|
*/
|
|
55
53
|
onAfterShow?: (event: Event) => void;
|
|
56
54
|
/**
|
|
57
|
-
*
|
|
55
|
+
* A callback fired immediately after the overlay is hidden.
|
|
58
56
|
*/
|
|
59
57
|
onHide?: (event: Event) => void;
|
|
60
58
|
/**
|
|
61
|
-
*
|
|
59
|
+
* A callback fired when the overlay is hidden, after any hide animations have completed.
|
|
62
60
|
*/
|
|
63
61
|
onAfterHide?: (event: Event) => void;
|
|
64
62
|
}
|
|
@@ -72,19 +70,19 @@ export interface BaseOverlayProps {
|
|
|
72
70
|
*/
|
|
73
71
|
export interface BaseOverlayMethods {
|
|
74
72
|
/**
|
|
75
|
-
*
|
|
73
|
+
* A method to programmatically show the overlay.
|
|
76
74
|
*
|
|
77
75
|
* @implementation This is a method to be called on the element and not a callback and should hence be camelCase
|
|
78
76
|
*/
|
|
79
77
|
showOverlay: () => void;
|
|
80
78
|
/**
|
|
81
|
-
*
|
|
79
|
+
* A method to programmatically hide the overlay and run any associated hide animations.
|
|
82
80
|
*
|
|
83
81
|
* @implementation This is a method to be called on the element and not a callback and should hence be camelCase
|
|
84
82
|
*/
|
|
85
83
|
hideOverlay: () => void;
|
|
86
84
|
/**
|
|
87
|
-
*
|
|
85
|
+
* A method to programmatically toggle the visibility of the overlay.
|
|
88
86
|
*
|
|
89
87
|
* @implementation This is a method to be called on the element and not a callback and should hence be camelCase
|
|
90
88
|
*/
|
|
@@ -92,48 +90,56 @@ export interface BaseOverlayMethods {
|
|
|
92
90
|
}
|
|
93
91
|
export interface FocusEventProps {
|
|
94
92
|
/**
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event
|
|
93
|
+
* A callback fired when the element loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).
|
|
98
94
|
*/
|
|
99
95
|
onBlur?: (event: FocusEvent) => void;
|
|
100
96
|
/**
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event
|
|
97
|
+
* A callback fired when the element receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).
|
|
104
98
|
*/
|
|
105
99
|
onFocus?: (event: FocusEvent) => void;
|
|
106
100
|
}
|
|
107
101
|
export interface ToggleEventProps {
|
|
108
102
|
/**
|
|
109
|
-
*
|
|
103
|
+
* A callback fired when the element state changes, after any toggle animations have finished.
|
|
110
104
|
*
|
|
111
105
|
* - If the element transitioned from hidden to showing, the `oldState` property will be set to `closed` and the
|
|
112
106
|
* `newState` property will be set to `open`.
|
|
113
107
|
* - If the element transitioned from showing to hidden, the `oldState` property will be set to `open` and the
|
|
114
108
|
* `newState` will be `closed`.
|
|
115
109
|
*
|
|
116
|
-
*
|
|
117
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState
|
|
110
|
+
* Learn more about the [`newState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState` property](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState).
|
|
118
111
|
*/
|
|
119
112
|
onAfterToggle?: (event: ToggleEvent$1) => void;
|
|
120
113
|
/**
|
|
121
|
-
*
|
|
114
|
+
* A callback fired immediately when the element state changes, before any animations.
|
|
122
115
|
*
|
|
123
116
|
* - If the element is transitioning from hidden to showing, the `oldState` property will be set to `closed` and the
|
|
124
117
|
* `newState` property will be set to `open`.
|
|
125
|
-
* - If the element is transitioning from showing to hidden, then `oldState` property will be set to `open` and the
|
|
118
|
+
* - If the element is transitioning from showing to hidden, then the `oldState` property will be set to `open` and the
|
|
126
119
|
* `newState` will be `closed`.
|
|
127
120
|
*
|
|
128
|
-
*
|
|
129
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState
|
|
130
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState
|
|
121
|
+
* Learn more about the [`toggle` event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/toggle_event), and the [`newState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/newState) and [`oldState`](https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/oldState) properties.
|
|
131
122
|
*/
|
|
132
123
|
onToggle?: (event: ToggleEvent$1) => void;
|
|
133
124
|
}
|
|
125
|
+
/**
|
|
126
|
+
* The visibility state of a toggleable element.
|
|
127
|
+
*
|
|
128
|
+
* - `open`: The element is visible and showing its content.
|
|
129
|
+
* - `closed`: The element is hidden and its content is not visible.
|
|
130
|
+
*/
|
|
134
131
|
export type ToggleState = "open" | "closed";
|
|
132
|
+
/**
|
|
133
|
+
* The event data provided to toggle-related callbacks. Contains the previous and next visibility states of the element.
|
|
134
|
+
*/
|
|
135
135
|
interface ToggleEvent$1 extends Event {
|
|
136
|
+
/**
|
|
137
|
+
* The visibility state of the element after the toggle occurred.
|
|
138
|
+
*/
|
|
136
139
|
readonly newState: ToggleState;
|
|
140
|
+
/**
|
|
141
|
+
* The visibility state of the element before the toggle occurred.
|
|
142
|
+
*/
|
|
137
143
|
readonly oldState: ToggleState;
|
|
138
144
|
}
|
|
139
145
|
export interface ExtendableEvent extends Event {
|
|
@@ -153,8 +159,7 @@ interface AnnouncementProps$1 extends GlobalProps, ToggleEventProps {
|
|
|
153
159
|
*/
|
|
154
160
|
children?: ComponentChildren;
|
|
155
161
|
/**
|
|
156
|
-
*
|
|
157
|
-
* (either via the built-in dismiss button or programmatically).
|
|
162
|
+
* A callback that fires when the announcement is dismissed by the user clicking the close button or by calling the `dismiss()` method programmatically.
|
|
158
163
|
*/
|
|
159
164
|
onDismiss?: (event: Event) => void;
|
|
160
165
|
/**
|
|
@@ -162,12 +167,32 @@ interface AnnouncementProps$1 extends GlobalProps, ToggleEventProps {
|
|
|
162
167
|
*/
|
|
163
168
|
dismiss: () => void;
|
|
164
169
|
}
|
|
170
|
+
/**
|
|
171
|
+
* The design system's size scale, used to control the dimensions of components like avatars, icons, and thumbnails. Values range from `"small-500"` (smallest) through `"base"` (standard) to `"large-500"` (largest). Not all components support every size — check the component's `size` property type for its available options.
|
|
172
|
+
*/
|
|
165
173
|
export type SizeKeyword = "small-500" | "small-400" | "small-300" | "small-200" | "small-100" | "small" | "base" | "large" | "large-100" | "large-200" | "large-300" | "large-400" | "large-500";
|
|
174
|
+
/**
|
|
175
|
+
* Defines the color intensity or emphasis level for text and UI elements.
|
|
176
|
+
*
|
|
177
|
+
* - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.
|
|
178
|
+
* - `base`: Primary color for body text, standard UI elements, and general content with good readability.
|
|
179
|
+
* - `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.
|
|
180
|
+
*/
|
|
166
181
|
export type ColorKeyword = "subdued" | "base" | "strong";
|
|
167
182
|
export type BackgroundColorKeyword = "transparent" | ColorKeyword;
|
|
168
183
|
export interface BackgroundProps {
|
|
169
184
|
/**
|
|
170
|
-
*
|
|
185
|
+
* The background color of the element.
|
|
186
|
+
*
|
|
187
|
+
* - `base`: The standard background color for general content areas.
|
|
188
|
+
* - `subdued`: A muted background for secondary or supporting content.
|
|
189
|
+
* - `transparent`: No background color (the default).
|
|
190
|
+
* - `strong`: An emphasized background for prominent sections.
|
|
191
|
+
*
|
|
192
|
+
* - `'transparent'`: No visible background.
|
|
193
|
+
* - `'subdued'`: A subtle, low-emphasis background.
|
|
194
|
+
* - `'base'`: The standard background color.
|
|
195
|
+
* - `'strong'`: A high-emphasis background for prominence.
|
|
171
196
|
*
|
|
172
197
|
* @default 'transparent'
|
|
173
198
|
*/
|
|
@@ -738,8 +763,28 @@ export type IconType = (typeof privateIconArray)[number];
|
|
|
738
763
|
* Like `Extract`, but ensures that the extracted type is a strict subtype of the input type.
|
|
739
764
|
*/
|
|
740
765
|
export type ExtractStrict<T, U extends T> = Extract<T, U>;
|
|
766
|
+
/**
|
|
767
|
+
* Represents CSS shorthand properties that accept one to four values, following the [CSS shorthand syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box). Supports specifying values for all four sides: top, right, bottom, and left.
|
|
768
|
+
*
|
|
769
|
+
* - `T`: Single value that applies to all four sides.
|
|
770
|
+
* - `${T} ${T}`: Two values for block axis (top/bottom) and inline axis (left/right).
|
|
771
|
+
* - `${T} ${T} ${T}`: Three values for block-start (top), inline axis (left/right), and block-end (bottom).
|
|
772
|
+
* - `${T} ${T} ${T} ${T}`: Four values for block-start (top), inline-end (right), block-end (bottom), and inline-start (left).
|
|
773
|
+
*/
|
|
741
774
|
export type MaybeAllValuesShorthandProperty<T extends string> = T | `${T} ${T}` | `${T} ${T} ${T}` | `${T} ${T} ${T} ${T}`;
|
|
775
|
+
/**
|
|
776
|
+
* Represents CSS shorthand properties that accept one or two values. Supports specifying the same value for both dimensions or different values.
|
|
777
|
+
*
|
|
778
|
+
* - `T`: Single value that applies to both dimensions.
|
|
779
|
+
* - `${T} ${T}`: Two values for block axis (vertical) and inline axis (horizontal).
|
|
780
|
+
*/
|
|
742
781
|
export type MaybeTwoValuesShorthandProperty<T extends string> = T | `${T} ${T}`;
|
|
782
|
+
/**
|
|
783
|
+
* Makes a property responsive by allowing it to be set conditionally based on container query conditions. The value can be either a base value or a container query string.
|
|
784
|
+
*
|
|
785
|
+
* - `T`: Base value that applies in all conditions.
|
|
786
|
+
* - `@container${string}`: Container query string for conditional responsive styling based on container size.
|
|
787
|
+
*/
|
|
743
788
|
export type MaybeResponsive<T> = T | `@container${string}`;
|
|
744
789
|
/**
|
|
745
790
|
* Prevents widening string literal types in a union to `string`.
|
|
@@ -763,29 +808,32 @@ interface BadgeProps$1 extends GlobalProps {
|
|
|
763
808
|
*/
|
|
764
809
|
children?: ComponentChildren;
|
|
765
810
|
/**
|
|
766
|
-
*
|
|
811
|
+
* The semantic meaning and color treatment of the badge.
|
|
767
812
|
*
|
|
768
813
|
* @default 'auto'
|
|
769
814
|
*/
|
|
770
815
|
tone?: ToneKeyword;
|
|
771
816
|
/**
|
|
772
|
-
*
|
|
817
|
+
* Controls the visual weight and emphasis of the badge.
|
|
773
818
|
*
|
|
774
819
|
* @default 'base'
|
|
775
820
|
*/
|
|
776
821
|
color?: ColorKeyword;
|
|
777
822
|
/**
|
|
778
|
-
*
|
|
823
|
+
* An icon displayed inside the badge to provide additional visual context or reinforce the badge's meaning. Set to an empty string to display no icon.
|
|
779
824
|
*
|
|
780
825
|
* @default ''
|
|
781
826
|
*/
|
|
782
827
|
icon?: IconType | AnyString;
|
|
783
828
|
/**
|
|
784
|
-
* The position of the icon
|
|
829
|
+
* The position of the icon relative to the badge text.
|
|
830
|
+
*
|
|
831
|
+
* - `start`: Places the icon before the text.
|
|
832
|
+
* - `end`: Places the icon after the text.
|
|
785
833
|
*/
|
|
786
834
|
iconPosition?: "start" | "end";
|
|
787
835
|
/**
|
|
788
|
-
*
|
|
836
|
+
* The size of the badge.
|
|
789
837
|
*
|
|
790
838
|
* @default 'base'
|
|
791
839
|
*/
|
|
@@ -793,42 +841,34 @@ interface BadgeProps$1 extends GlobalProps {
|
|
|
793
841
|
}
|
|
794
842
|
interface BannerProps$1 extends GlobalProps, ActionSlots {
|
|
795
843
|
/**
|
|
796
|
-
* The
|
|
844
|
+
* The heading text displayed at the top of the banner to summarize the message or alert.
|
|
797
845
|
*
|
|
798
846
|
* @default ''
|
|
799
847
|
*/
|
|
800
848
|
heading?: string;
|
|
801
849
|
/**
|
|
802
|
-
* The content
|
|
850
|
+
* The main content displayed within the banner component, typically descriptive text or other elements providing details about the message or alert.
|
|
803
851
|
*/
|
|
804
852
|
children?: ComponentChildren;
|
|
805
853
|
/**
|
|
806
|
-
*
|
|
807
|
-
*
|
|
808
|
-
* The banner is a live region and the type of status will be dictated by the Tone selected.
|
|
809
|
-
*
|
|
810
|
-
* - `critical` creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately.
|
|
811
|
-
* - `neutral`, `info`, `success`, `warning` and `caution` creates an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.
|
|
854
|
+
* The semantic meaning and color treatment of the component. The banner is a live region and the type of status is dictated by the tone selected.
|
|
812
855
|
*
|
|
813
|
-
*
|
|
814
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role
|
|
815
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role
|
|
856
|
+
* The `critical` tone creates an [assertive live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/alert_role) that is announced by screen readers immediately. The `neutral`, `info`, `success`, `warning`, and `caution` tones create an [informative live region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/status_role) that is announced by screen readers after the current message.
|
|
816
857
|
*
|
|
817
858
|
* @default 'auto'
|
|
818
859
|
*/
|
|
819
860
|
tone?: ToneKeyword;
|
|
820
861
|
/**
|
|
821
|
-
*
|
|
822
|
-
* A collapsible banner will conceal child elements initially, but allow the user to expand the banner to see them.
|
|
862
|
+
* Whether the banner content can be collapsed and expanded by the user. A collapsible banner conceals child elements initially, allowing the user to expand the banner to reveal them.
|
|
823
863
|
*
|
|
824
864
|
* @default false
|
|
825
865
|
*/
|
|
826
866
|
collapsible?: boolean;
|
|
827
867
|
/**
|
|
828
|
-
*
|
|
868
|
+
* Whether the banner displays a close button that allows users to dismiss it.
|
|
829
869
|
*
|
|
830
870
|
* When the close button is pressed, the `dismiss` event will fire,
|
|
831
|
-
* then `hidden` will be true
|
|
871
|
+
* then `hidden` will be set to `true`,
|
|
832
872
|
* any animation will complete,
|
|
833
873
|
* and the `afterhide` event will fire.
|
|
834
874
|
*
|
|
@@ -836,31 +876,26 @@ interface BannerProps$1 extends GlobalProps, ActionSlots {
|
|
|
836
876
|
*/
|
|
837
877
|
dismissible?: boolean;
|
|
838
878
|
/**
|
|
839
|
-
*
|
|
879
|
+
* A callback that fires when the banner is dismissed by the user clicking the close button.
|
|
840
880
|
*
|
|
841
|
-
* This
|
|
881
|
+
* This doesn't fire when setting `hidden` manually.
|
|
842
882
|
*
|
|
843
|
-
* The `hidden` property
|
|
883
|
+
* The `hidden` property is `false` when this event fires.
|
|
844
884
|
*/
|
|
845
885
|
onDismiss?: (event: Event) => void;
|
|
846
886
|
/**
|
|
847
|
-
*
|
|
887
|
+
* A callback that fires when the banner has fully hidden, including after any hide animations have completed.
|
|
848
888
|
*
|
|
849
|
-
* The `hidden` property
|
|
850
|
-
*
|
|
851
|
-
* @implementation If implementations animate the hiding of the banner,
|
|
852
|
-
* this event must fire after the banner has fully hidden.
|
|
853
|
-
* We can add an `onHide` event in future if we want to provide a hook for the start of the animation.
|
|
889
|
+
* The `hidden` property is `true` when this event fires.
|
|
854
890
|
*/
|
|
855
891
|
onAfterHide?: (event: Event) => void;
|
|
856
892
|
/**
|
|
857
|
-
*
|
|
893
|
+
* Controls whether the banner is visible or hidden.
|
|
858
894
|
*
|
|
859
|
-
*
|
|
860
|
-
*
|
|
861
|
-
* ensure you update app state for this property when the `dismiss` event fires.
|
|
895
|
+
* When using a controlled component pattern and the banner is `dismissible`,
|
|
896
|
+
* update this property to `true` when the `dismiss` event fires.
|
|
862
897
|
*
|
|
863
|
-
*
|
|
898
|
+
* You can hide the banner programmatically by setting this to `true` even if it's not `dismissible`.
|
|
864
899
|
*
|
|
865
900
|
* @default false
|
|
866
901
|
*/
|
|
@@ -870,27 +905,43 @@ export interface DisplayProps {
|
|
|
870
905
|
/**
|
|
871
906
|
* Sets the outer display type of the component. The outer type sets a component’s participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout).
|
|
872
907
|
*
|
|
873
|
-
* - `auto`:
|
|
874
|
-
* - `none`:
|
|
908
|
+
* - `auto`: The component’s initial value. The actual value depends on the component and context.
|
|
909
|
+
* - `none`: Hides the component from display and removes it from the accessibility tree, making it invisible to screen readers.
|
|
910
|
+
*
|
|
911
|
+
* Learn more about the [display property](https://developer.mozilla.org/en-US/docs/Web/CSS/display).
|
|
875
912
|
*
|
|
876
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/display
|
|
877
913
|
* @default 'auto'
|
|
878
914
|
*/
|
|
879
915
|
display?: MaybeResponsive<"auto" | "none">;
|
|
880
916
|
}
|
|
881
917
|
export interface AccessibilityRoleProps {
|
|
882
918
|
/**
|
|
883
|
-
*
|
|
884
|
-
* the role will be used by assistive technologies to help users
|
|
885
|
-
* navigate the page.
|
|
886
|
-
*
|
|
887
|
-
* @implementation Although, in HTML hosts, this property changes the element used,
|
|
888
|
-
* changing this property must not impact the visual styling of inside or outside of the box.
|
|
919
|
+
* The semantic meaning of the component's content. When set, assistive technologies use this role to help users navigate the page.
|
|
889
920
|
*
|
|
890
921
|
* @default 'generic'
|
|
891
922
|
*/
|
|
892
923
|
accessibilityRole?: AccessibilityRole;
|
|
893
924
|
}
|
|
925
|
+
/**
|
|
926
|
+
* The semantic role of a component, used by assistive technologies to convey the element's purpose to users. Each role maps to a specific HTML element or ARIA role.
|
|
927
|
+
*
|
|
928
|
+
* - `main`: The primary content of the page.
|
|
929
|
+
* - `header`: A page or section header.
|
|
930
|
+
* - `footer`: Information such as copyright, navigation links, and privacy statements.
|
|
931
|
+
* - `section`: A generic section that should have a heading or `accessibilityLabel`.
|
|
932
|
+
* - `aside`: Supporting content related to the main content.
|
|
933
|
+
* - `navigation`: A major group of navigation links.
|
|
934
|
+
* - `ordered-list`: A list of ordered items.
|
|
935
|
+
* - `list-item`: An item inside a list.
|
|
936
|
+
* - `list-item-separator`: A divider between list items.
|
|
937
|
+
* - `unordered-list`: A list of unordered items.
|
|
938
|
+
* - `separator`: A divider that separates sections of content.
|
|
939
|
+
* - `status`: A live region with advisory information that is not urgent.
|
|
940
|
+
* - `alert`: Important, usually time-sensitive information.
|
|
941
|
+
* - `generic`: A nameless container with no semantic meaning (renders a `<div>`).
|
|
942
|
+
* - `presentation`: Strips semantic meaning while keeping visual styling. Synonym for `none`.
|
|
943
|
+
* - `none`: Strips semantic meaning while keeping visual styling. Synonym for `presentation`.
|
|
944
|
+
*/
|
|
894
945
|
export type AccessibilityRole =
|
|
895
946
|
/**
|
|
896
947
|
* Used to indicate the primary content.
|
|
@@ -903,7 +954,7 @@ export type AccessibilityRole =
|
|
|
903
954
|
* Used to indicate the component is a header.
|
|
904
955
|
*
|
|
905
956
|
* In an HTML host `header` will render a `<header>` element.
|
|
906
|
-
* Learn more about the [`<header>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/
|
|
957
|
+
* Learn more about the [`<header>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/banner_role) in the MDN web docs.
|
|
907
958
|
*/
|
|
908
959
|
| "header"
|
|
909
960
|
/**
|
|
@@ -1008,11 +1059,11 @@ export type AccessibilityRole =
|
|
|
1008
1059
|
| "none";
|
|
1009
1060
|
export interface AccessibilityVisibilityProps {
|
|
1010
1061
|
/**
|
|
1011
|
-
*
|
|
1062
|
+
* Controls how the element is exposed to sighted users and to assistive technologies such as screen readers.
|
|
1012
1063
|
*
|
|
1013
|
-
* - `visible`:
|
|
1014
|
-
* - `hidden`:
|
|
1015
|
-
* - `exclusive`:
|
|
1064
|
+
* - `visible`: The element is visible to all users (both sighted users and screen readers).
|
|
1065
|
+
* - `hidden`: The element is visually visible but hidden from screen readers. Use this for decorative elements that don't provide meaningful information.
|
|
1066
|
+
* - `exclusive`: The element is visually hidden but announced by screen readers. Use this for screen-reader-only content like skip links or additional context.
|
|
1016
1067
|
*
|
|
1017
1068
|
* @default 'visible'
|
|
1018
1069
|
*/
|
|
@@ -1020,162 +1071,198 @@ export interface AccessibilityVisibilityProps {
|
|
|
1020
1071
|
}
|
|
1021
1072
|
export interface LabelAccessibilityVisibilityProps {
|
|
1022
1073
|
/**
|
|
1023
|
-
*
|
|
1074
|
+
* Controls whether the label is visible to all users or only to screen readers.
|
|
1024
1075
|
*
|
|
1025
|
-
* - `visible`:
|
|
1026
|
-
* - `exclusive`:
|
|
1076
|
+
* - `visible`: The label is shown to everyone.
|
|
1077
|
+
* - `exclusive`: The label is visually hidden but still announced by screen readers.
|
|
1027
1078
|
*
|
|
1028
1079
|
* @default 'visible'
|
|
1029
1080
|
*/
|
|
1030
1081
|
labelAccessibilityVisibility?: ExtractStrict<AccessibilityVisibilityProps["accessibilityVisibility"], "visible" | "exclusive">;
|
|
1031
1082
|
}
|
|
1083
|
+
/**
|
|
1084
|
+
* Defines the padding size for elements, using the standard size scale or `none` for no padding.
|
|
1085
|
+
*
|
|
1086
|
+
* - `SizeKeyword`: Standard padding sizes from the size scale for consistent spacing.
|
|
1087
|
+
* - `none`: No padding.
|
|
1088
|
+
*/
|
|
1032
1089
|
export type PaddingKeyword = SizeKeyword | "none";
|
|
1033
1090
|
export interface PaddingProps {
|
|
1034
1091
|
/**
|
|
1035
|
-
*
|
|
1092
|
+
* The padding applied to all edges of the component.
|
|
1036
1093
|
*
|
|
1037
|
-
* [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box)
|
|
1038
|
-
*
|
|
1094
|
+
* 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:
|
|
1095
|
+
* - 1 value applies to all sides
|
|
1096
|
+
* - 2 values apply to block (top/bottom) and inline (left/right)
|
|
1097
|
+
* - 3 values apply to block-start (top), inline (left/right), and block-end (bottom)
|
|
1098
|
+
* - 4 values apply to block-start (top), inline-end (right), block-end (bottom), and inline-start (left)
|
|
1039
1099
|
*
|
|
1040
|
-
*
|
|
1041
|
-
* - 3 values: `block-start inline block-end`
|
|
1042
|
-
* - 2 values: `block inline`
|
|
1100
|
+
* **Examples:** `base`, `large none`, `base large-100 base small`
|
|
1043
1101
|
*
|
|
1044
|
-
*
|
|
1045
|
-
* - `large` means block-start, inline-end, block-end and inline-start paddings are `large`.
|
|
1046
|
-
* - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`.
|
|
1047
|
-
* - `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`.
|
|
1048
|
-
* - `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`.
|
|
1049
|
-
*
|
|
1050
|
-
* A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed.
|
|
1102
|
+
* Use `auto` to inherit padding from the nearest container with removed padding.
|
|
1051
1103
|
*
|
|
1052
1104
|
* @default 'none'
|
|
1053
1105
|
*/
|
|
1054
1106
|
padding?: MaybeResponsive<MaybeAllValuesShorthandProperty<PaddingKeyword>>;
|
|
1055
1107
|
/**
|
|
1056
|
-
*
|
|
1108
|
+
* The block-direction padding (top and bottom in horizontal writing modes).
|
|
1109
|
+
*
|
|
1110
|
+
* Accepts a single value for both sides or two space-separated values for block-start and block-end.
|
|
1057
1111
|
*
|
|
1058
|
-
*
|
|
1112
|
+
* **Example:** `large none` applies `large` to the top and `none` to the bottom.
|
|
1059
1113
|
*
|
|
1060
|
-
*
|
|
1114
|
+
* Overrides the block value from `padding`.
|
|
1061
1115
|
*
|
|
1062
1116
|
* @default '' - meaning no override
|
|
1063
1117
|
*/
|
|
1064
1118
|
paddingBlock?: MaybeResponsive<MaybeTwoValuesShorthandProperty<PaddingKeyword> | "">;
|
|
1065
1119
|
/**
|
|
1066
|
-
*
|
|
1120
|
+
* The block-start padding (top in horizontal writing modes).
|
|
1067
1121
|
*
|
|
1068
|
-
*
|
|
1122
|
+
* Overrides the block-start value from `paddingBlock`.
|
|
1069
1123
|
*
|
|
1070
1124
|
* @default '' - meaning no override
|
|
1071
1125
|
*/
|
|
1072
1126
|
paddingBlockStart?: MaybeResponsive<PaddingKeyword | "">;
|
|
1073
1127
|
/**
|
|
1074
|
-
*
|
|
1128
|
+
* The block-end padding (bottom in horizontal writing modes).
|
|
1075
1129
|
*
|
|
1076
|
-
*
|
|
1130
|
+
* Overrides the block-end value from `paddingBlock`.
|
|
1077
1131
|
*
|
|
1078
1132
|
* @default '' - meaning no override
|
|
1079
1133
|
*/
|
|
1080
1134
|
paddingBlockEnd?: MaybeResponsive<PaddingKeyword | "">;
|
|
1081
1135
|
/**
|
|
1082
|
-
*
|
|
1136
|
+
* The inline-direction padding (left and right in horizontal writing modes).
|
|
1083
1137
|
*
|
|
1084
|
-
* -
|
|
1138
|
+
* Accepts a single value for both sides or two space-separated values for inline-start and inline-end.
|
|
1085
1139
|
*
|
|
1086
|
-
*
|
|
1140
|
+
* **Example:** `large none` applies `large` to the left and `none` to the right.
|
|
1141
|
+
*
|
|
1142
|
+
* Overrides the inline value from `padding`.
|
|
1087
1143
|
*
|
|
1088
1144
|
* @default '' - meaning no override
|
|
1089
1145
|
*/
|
|
1090
1146
|
paddingInline?: MaybeResponsive<MaybeTwoValuesShorthandProperty<PaddingKeyword> | "">;
|
|
1091
1147
|
/**
|
|
1092
|
-
*
|
|
1148
|
+
* The inline-start padding (left in LTR writing modes, right in RTL).
|
|
1093
1149
|
*
|
|
1094
|
-
*
|
|
1150
|
+
* Overrides the inline-start value from `paddingInline`.
|
|
1095
1151
|
*
|
|
1096
1152
|
* @default '' - meaning no override
|
|
1097
1153
|
*/
|
|
1098
1154
|
paddingInlineStart?: MaybeResponsive<PaddingKeyword | "">;
|
|
1099
1155
|
/**
|
|
1100
|
-
*
|
|
1156
|
+
* The inline-end padding (right in LTR writing modes, left in RTL).
|
|
1101
1157
|
*
|
|
1102
|
-
*
|
|
1158
|
+
* Overrides the inline-end value from `paddingInline`.
|
|
1103
1159
|
*
|
|
1104
1160
|
* @default '' - meaning no override
|
|
1105
1161
|
*/
|
|
1106
1162
|
paddingInlineEnd?: MaybeResponsive<PaddingKeyword | "">;
|
|
1107
1163
|
}
|
|
1164
|
+
/**
|
|
1165
|
+
* Represents size values in pixels, percentages, or zero.
|
|
1166
|
+
*
|
|
1167
|
+
* - `` `${number}px` ``: Absolute size in pixels for fixed dimensions (such as `100px`, `24px`).
|
|
1168
|
+
* - `` `${number}%` ``: Relative size as a percentage of the parent container (such as `50%`, `100%`).
|
|
1169
|
+
* - `0`: Zero size, equivalent to no dimension.
|
|
1170
|
+
*/
|
|
1108
1171
|
export type SizeUnits = `${number}px` | `${number}%` | `0`;
|
|
1172
|
+
/**
|
|
1173
|
+
* Represents size values that can also be set to `auto` for automatic sizing.
|
|
1174
|
+
*
|
|
1175
|
+
* - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
|
|
1176
|
+
* - `auto`: Automatically sizes based on content and layout constraints. Learn more about the [auto value](https://developer.mozilla.org/en-US/docs/Web/CSS/width#auto).
|
|
1177
|
+
*/
|
|
1109
1178
|
export type SizeUnitsOrAuto = SizeUnits | "auto";
|
|
1179
|
+
/**
|
|
1180
|
+
* Represents size values that can also be set to `none` to remove the size constraint.
|
|
1181
|
+
*
|
|
1182
|
+
* - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
|
|
1183
|
+
* - `none`: No size constraint, allowing unlimited growth. Learn more about the [none value](https://developer.mozilla.org/en-US/docs/Web/CSS/max-width#none).
|
|
1184
|
+
*/
|
|
1110
1185
|
export type SizeUnitsOrNone = SizeUnits | "none";
|
|
1111
1186
|
export interface SizingProps {
|
|
1112
1187
|
/**
|
|
1113
|
-
*
|
|
1188
|
+
* The block size of the element (height in horizontal writing modes). Learn more about the [block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size).
|
|
1114
1189
|
*
|
|
1115
|
-
*
|
|
1190
|
+
* - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
|
|
1191
|
+
* - `auto`: Automatically sizes based on content and layout constraints.
|
|
1116
1192
|
*
|
|
1117
1193
|
* @default 'auto'
|
|
1118
1194
|
*/
|
|
1119
1195
|
blockSize?: MaybeResponsive<SizeUnitsOrAuto>;
|
|
1120
1196
|
/**
|
|
1121
|
-
*
|
|
1122
|
-
*
|
|
1123
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size
|
|
1197
|
+
* The minimum block size of the element (minimum height in horizontal writing modes). Learn more about the [min-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).
|
|
1124
1198
|
*
|
|
1125
1199
|
* @default '0'
|
|
1126
1200
|
*/
|
|
1127
1201
|
minBlockSize?: MaybeResponsive<SizeUnits>;
|
|
1128
1202
|
/**
|
|
1129
|
-
*
|
|
1130
|
-
*
|
|
1131
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size
|
|
1203
|
+
* The maximum block size of the element (maximum height in horizontal writing modes). Learn more about the [max-block-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).
|
|
1132
1204
|
*
|
|
1133
1205
|
* @default 'none'
|
|
1134
1206
|
*/
|
|
1135
1207
|
maxBlockSize?: MaybeResponsive<SizeUnitsOrNone>;
|
|
1136
1208
|
/**
|
|
1137
|
-
*
|
|
1209
|
+
* The inline size of the element (width in horizontal writing modes). Learn more about the [inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size).
|
|
1138
1210
|
*
|
|
1139
|
-
*
|
|
1211
|
+
* - `SizeUnits`: Specific size values in pixels, percentages, or zero for precise control.
|
|
1212
|
+
* - `auto`: Automatically sizes based on content and layout constraints.
|
|
1140
1213
|
*
|
|
1141
1214
|
* @default 'auto'
|
|
1142
1215
|
*/
|
|
1143
1216
|
inlineSize?: MaybeResponsive<SizeUnitsOrAuto>;
|
|
1144
1217
|
/**
|
|
1145
|
-
*
|
|
1146
|
-
*
|
|
1147
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size
|
|
1218
|
+
* The minimum inline size of the element (minimum width in horizontal writing modes). Learn more about the [min-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).
|
|
1148
1219
|
*
|
|
1149
1220
|
* @default '0'
|
|
1150
1221
|
*/
|
|
1151
1222
|
minInlineSize?: MaybeResponsive<SizeUnits>;
|
|
1152
1223
|
/**
|
|
1153
|
-
*
|
|
1154
|
-
*
|
|
1155
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size
|
|
1224
|
+
* The maximum inline size of the element (maximum width in horizontal writing modes). Learn more about the [max-inline-size property](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).
|
|
1156
1225
|
*
|
|
1157
1226
|
* @default 'none'
|
|
1158
1227
|
*/
|
|
1159
1228
|
maxInlineSize?: MaybeResponsive<SizeUnitsOrNone>;
|
|
1160
1229
|
}
|
|
1230
|
+
/**
|
|
1231
|
+
* The visual style of a border. Learn more about [border-style](https://developer.mozilla.org/en-US/docs/Web/CSS/border-style).
|
|
1232
|
+
*
|
|
1233
|
+
* - `"none"`: No border is rendered.
|
|
1234
|
+
* - `"solid"`: A single continuous line.
|
|
1235
|
+
* - `"dashed"`: A series of short dashes.
|
|
1236
|
+
* - `"dotted"`: A series of round dots.
|
|
1237
|
+
* - `"auto"`: The border style is determined automatically based on the surface's design system.
|
|
1238
|
+
*/
|
|
1161
1239
|
export type BorderStyleKeyword = "none" | "solid" | "dashed" | "dotted" | "auto";
|
|
1240
|
+
/**
|
|
1241
|
+
* Defines the width of borders, using the standard size scale or `none` for no border.
|
|
1242
|
+
*
|
|
1243
|
+
* - `SizeKeyword`: Standard border widths from the size scale for consistent thickness.
|
|
1244
|
+
* - `none`: No border width (removes the border).
|
|
1245
|
+
*/
|
|
1162
1246
|
export type BorderSizeKeyword = SizeKeyword | "none";
|
|
1247
|
+
/**
|
|
1248
|
+
* The corner radius of a border, using the design system's `SizeKeyword` scale with additional options:
|
|
1249
|
+
*
|
|
1250
|
+
* - `"max"`: The maximum possible radius, creating a pill or circular shape.
|
|
1251
|
+
* - `"none"`: No rounding — corners are sharp (0 radius).
|
|
1252
|
+
*/
|
|
1163
1253
|
export type BorderRadiusKeyword = SizeKeyword | "max" | "none";
|
|
1164
1254
|
/**
|
|
1165
|
-
*
|
|
1255
|
+
* A shorthand string for specifying border properties. Accepts a size alone (`'base'`), size with color (`'base strong'`), or size with color and style (`'base strong dashed'`). Omitted values use their defaults.
|
|
1166
1256
|
*/
|
|
1167
1257
|
export type BorderShorthand = BorderSizeKeyword | `${BorderSizeKeyword} ${ColorKeyword}` | `${BorderSizeKeyword} ${ColorKeyword} ${BorderStyleKeyword}`;
|
|
1168
1258
|
export interface BorderProps {
|
|
1169
1259
|
/**
|
|
1170
|
-
*
|
|
1171
|
-
*
|
|
1172
|
-
* This can be a size, optionally followed by a color, optionally followed by a style.
|
|
1260
|
+
* Applies a border using shorthand syntax to specify width, color, and style in a single property.
|
|
1173
1261
|
*
|
|
1174
|
-
*
|
|
1262
|
+
* Accepts a size value, optionally followed by a color, optionally followed by a style.
|
|
1263
|
+
* Omitted values use defaults: color defaults to `base`, style defaults to `auto`.
|
|
1175
1264
|
*
|
|
1176
|
-
*
|
|
1177
|
-
*
|
|
1178
|
-
* Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`.
|
|
1265
|
+
* Individual properties (`borderWidth`, `borderStyle`, `borderColor`) can override values set here.
|
|
1179
1266
|
*
|
|
1180
1267
|
* @example
|
|
1181
1268
|
* // The following are equivalent:
|
|
@@ -1186,64 +1273,54 @@ export interface BorderProps {
|
|
|
1186
1273
|
*/
|
|
1187
1274
|
border?: BorderShorthand;
|
|
1188
1275
|
/**
|
|
1189
|
-
*
|
|
1190
|
-
*
|
|
1191
|
-
* If set, it takes precedence over the `border` property's width.
|
|
1192
|
-
*
|
|
1193
|
-
* Like CSS, up to 4 values can be specified.
|
|
1194
|
-
*
|
|
1195
|
-
* If one value is specified, it applies to all sides.
|
|
1196
|
-
*
|
|
1197
|
-
* If two values are specified, they apply to the block sides and inline sides respectively.
|
|
1198
|
-
*
|
|
1199
|
-
* If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
|
|
1276
|
+
* Controls the thickness of the border on all sides. When set, this overrides the width value specified in the `border` property.
|
|
1200
1277
|
*
|
|
1201
|
-
*
|
|
1278
|
+
* 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:
|
|
1279
|
+
* - One value: applies to all sides
|
|
1280
|
+
* - Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively
|
|
1281
|
+
* - Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively
|
|
1282
|
+
* - Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively
|
|
1202
1283
|
*
|
|
1203
1284
|
* @default '' - meaning no override
|
|
1204
1285
|
*/
|
|
1205
1286
|
borderWidth?: MaybeAllValuesShorthandProperty<BorderSizeKeyword> | "";
|
|
1206
1287
|
/**
|
|
1207
|
-
*
|
|
1288
|
+
* Controls the visual style of the border on all sides, such as solid, dashed, or dotted.
|
|
1208
1289
|
*
|
|
1209
|
-
*
|
|
1290
|
+
* When set, this overrides the style value specified in the `border` property.
|
|
1210
1291
|
*
|
|
1211
|
-
*
|
|
1212
|
-
*
|
|
1213
|
-
*
|
|
1214
|
-
*
|
|
1215
|
-
*
|
|
1216
|
-
*
|
|
1217
|
-
* If three values are specified, they apply to the block-start, both inline sides, and block-end respectively.
|
|
1218
|
-
*
|
|
1219
|
-
* If four values are specified, they apply to the block-start, block-end, inline-start, and inline-end sides respectively.
|
|
1292
|
+
* 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:
|
|
1293
|
+
* - One value: applies to all sides
|
|
1294
|
+
* - Two values: applies to block sides (top/bottom) and inline sides (left/right) respectively
|
|
1295
|
+
* - Three values: applies to block-start (top), inline sides (left/right), and block-end (bottom) respectively
|
|
1296
|
+
* - Four values: applies to block-start (top), inline-end (right), block-end (bottom), and inline-start (left) respectively
|
|
1220
1297
|
*
|
|
1221
1298
|
* @default '' - meaning no override
|
|
1222
1299
|
*/
|
|
1223
1300
|
borderStyle?: MaybeAllValuesShorthandProperty<BorderStyleKeyword> | "";
|
|
1224
1301
|
/**
|
|
1225
|
-
*
|
|
1302
|
+
* Controls the color of the border using the design system's color scale.
|
|
1226
1303
|
*
|
|
1227
|
-
*
|
|
1304
|
+
* When set, this overrides the color value specified in the `border` property.
|
|
1305
|
+
* Choose from `subdued`, `base`, or `strong` to match the visual emphasis needed.
|
|
1228
1306
|
*
|
|
1229
1307
|
* @default '' - meaning no override
|
|
1230
1308
|
*/
|
|
1231
1309
|
borderColor?: ColorKeyword | "";
|
|
1232
1310
|
/**
|
|
1233
|
-
*
|
|
1311
|
+
* Controls the roundedness of the element's corners using the design system's radius scale.
|
|
1234
1312
|
*
|
|
1235
|
-
* [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box)
|
|
1236
|
-
*
|
|
1313
|
+
* 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:
|
|
1314
|
+
* - One value: applies to all corners
|
|
1315
|
+
* - Two values: applies to start corners (top-left & bottom-right) and end corners (top-right & bottom-left) respectively
|
|
1316
|
+
* - Three values: applies to start-start (top-left), end corners (top-right & bottom-left), and end-end (bottom-right) respectively
|
|
1317
|
+
* - Four values: applies to start-start (top-left), start-end (top-right), end-end (bottom-right), and end-start (bottom-left) respectively
|
|
1237
1318
|
*
|
|
1238
|
-
*
|
|
1239
|
-
* -
|
|
1240
|
-
* -
|
|
1241
|
-
*
|
|
1242
|
-
*
|
|
1243
|
-
* - `small-100` means start-start, start-end, end-end and end-start border radii are `small-100`.
|
|
1244
|
-
* - `small-100 none` means start-start and end-end border radii are `small-100`, start-end and end-start border radii are `none`.
|
|
1245
|
-
* - `small-100 none large-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `none`.
|
|
1246
|
-
* - `small-100 none large-100 small-100` means start-start border radius is `small-100`, start-end border radius is `none`, end-end border radius is `large-100` and end-start border radius is `small-100`.
|
|
1319
|
+
* Examples:
|
|
1320
|
+
* - `small-100`: All corners have `small-100` radius
|
|
1321
|
+
* - `small-100 none`: Top-left and bottom-right are `small-100`, top-right and bottom-left are `none`
|
|
1322
|
+
* - `small-100 none large-100`: Top-left is `small-100`, top-right and bottom-left are `none`, bottom-right is `large-100`
|
|
1323
|
+
* - `small-100 none large-100 base`: Each corner has its specified radius value
|
|
1247
1324
|
*
|
|
1248
1325
|
* @defaultValue 'none'
|
|
1249
1326
|
*/
|
|
@@ -1251,12 +1328,10 @@ export interface BorderProps {
|
|
|
1251
1328
|
}
|
|
1252
1329
|
export interface OverflowProps {
|
|
1253
1330
|
/**
|
|
1254
|
-
*
|
|
1331
|
+
* The overflow behavior of the element.
|
|
1255
1332
|
*
|
|
1256
|
-
* - `
|
|
1257
|
-
*
|
|
1258
|
-
* to access the clipped content by dragging or using a scroll wheel on a mouse.
|
|
1259
|
-
* - `visible`: the content that extends beyond the element’s container is visible.
|
|
1333
|
+
* - `visible`: Content that extends beyond the container is visible.
|
|
1334
|
+
* - `hidden`: Content that extends beyond the container is clipped and not scrollable.
|
|
1260
1335
|
*
|
|
1261
1336
|
* @default 'visible'
|
|
1262
1337
|
*/
|
|
@@ -1264,14 +1339,11 @@ export interface OverflowProps {
|
|
|
1264
1339
|
}
|
|
1265
1340
|
export interface BaseBoxProps extends AccessibilityVisibilityProps, BackgroundProps, DisplayProps, SizingProps, PaddingProps, BorderProps, OverflowProps {
|
|
1266
1341
|
/**
|
|
1267
|
-
* The
|
|
1342
|
+
* The child elements to render inside the container.
|
|
1268
1343
|
*/
|
|
1269
1344
|
children?: ComponentChildren;
|
|
1270
1345
|
/**
|
|
1271
|
-
* A label that describes the purpose or contents of the element.
|
|
1272
|
-
* When set, it will be announced to users using assistive technologies and will provide them with more context.
|
|
1273
|
-
*
|
|
1274
|
-
* Only use this when the element's content is not enough context for users using assistive technologies.
|
|
1346
|
+
* A label announced by assistive technologies that describes the purpose or contents of the element. Only set this when the element's visible content doesn't provide enough context on its own.
|
|
1275
1347
|
*/
|
|
1276
1348
|
accessibilityLabel?: string;
|
|
1277
1349
|
}
|
|
@@ -1281,34 +1353,28 @@ interface BoxProps$1 extends BaseBoxPropsWithRole, GlobalProps {
|
|
|
1281
1353
|
}
|
|
1282
1354
|
export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
|
|
1283
1355
|
/**
|
|
1284
|
-
* The
|
|
1356
|
+
* The behavioral type of the button component, which determines what action it performs when activated.
|
|
1357
|
+
* - `'submit'`: Submits the nearest containing form.
|
|
1358
|
+
* - `'button'`: Performs no default action, relying on the `click` event handler for behavior.
|
|
1359
|
+
* - `'reset'`: Resets all fields in the nearest containing form to their default values.
|
|
1285
1360
|
*
|
|
1286
|
-
*
|
|
1287
|
-
* - `button`: Used to indicate the component acts as a button, meaning it has no default action.
|
|
1288
|
-
* - `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values).
|
|
1289
|
-
*
|
|
1290
|
-
* This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set.
|
|
1361
|
+
* This property is ignored if `href` or `commandFor`/`command` is set.
|
|
1291
1362
|
*
|
|
1292
1363
|
* @default 'button'
|
|
1293
1364
|
*/
|
|
1294
1365
|
type?: "submit" | "button" | "reset";
|
|
1295
1366
|
/**
|
|
1296
|
-
*
|
|
1297
|
-
* This will be called before the action indicated by `type`.
|
|
1298
|
-
*
|
|
1299
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event
|
|
1367
|
+
* A callback fired when the button is activated, before performing the action indicated by `type`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).
|
|
1300
1368
|
*/
|
|
1301
1369
|
onClick?: (event: Event) => void;
|
|
1302
1370
|
/**
|
|
1303
|
-
*
|
|
1371
|
+
* Whether the button is disabled, preventing it from being clicked or receiving focus.
|
|
1304
1372
|
*
|
|
1305
1373
|
* @default false
|
|
1306
1374
|
*/
|
|
1307
1375
|
disabled?: boolean;
|
|
1308
1376
|
/**
|
|
1309
|
-
*
|
|
1310
|
-
*
|
|
1311
|
-
* This also disables the Button.
|
|
1377
|
+
* Whether the button is in a loading state, which replaces the button content with a loading indicator while a background action is being performed. This also disables the button.
|
|
1312
1378
|
*
|
|
1313
1379
|
* @default false
|
|
1314
1380
|
*/
|
|
@@ -1316,18 +1382,14 @@ export interface ButtonBehaviorProps extends InteractionProps, FocusEventProps {
|
|
|
1316
1382
|
}
|
|
1317
1383
|
export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
|
|
1318
1384
|
/**
|
|
1319
|
-
* The URL to
|
|
1320
|
-
*
|
|
1321
|
-
* - If set, it will navigate to the location specified by `href` after executing the `click` event.
|
|
1322
|
-
* - If a `commandFor` is set, the `command` will be executed instead of the navigation.
|
|
1385
|
+
* 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.
|
|
1323
1386
|
*/
|
|
1324
1387
|
href?: string;
|
|
1325
1388
|
/**
|
|
1326
|
-
* Specifies where to display the linked URL.
|
|
1327
|
-
*
|
|
1328
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target
|
|
1389
|
+
* Specifies where to display the linked URL. Learn more about the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).
|
|
1329
1390
|
*
|
|
1330
|
-
* 'auto'
|
|
1391
|
+
* - `'auto'`: Opens the URL in the current frame or a new tab, depending on the context.
|
|
1392
|
+
* - `'_blank'`: Opens the URL in a new tab or window.
|
|
1331
1393
|
*
|
|
1332
1394
|
* @implementation Surfaces can set specific rules on how they handle each URL.
|
|
1333
1395
|
* @implementation It’s expected that the behavior of `auto` is as `_self` except in specific cases.
|
|
@@ -1337,46 +1399,35 @@ export interface LinkBehaviorProps extends InteractionProps, FocusEventProps {
|
|
|
1337
1399
|
*/
|
|
1338
1400
|
target?: "auto" | "_blank" | "_self" | "_parent" | "_top" | AnyString;
|
|
1339
1401
|
/**
|
|
1340
|
-
*
|
|
1341
|
-
* Download only works for same-origin URLs or the `blob:` and `data:` schemes.
|
|
1342
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download
|
|
1402
|
+
* A filename that causes the browser to treat the linked URL as a download. Download is only supported for same-origin URLs, or `blob:` and `data:` schemes. Learn more about the [download attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).
|
|
1343
1403
|
*/
|
|
1344
1404
|
download?: string;
|
|
1345
1405
|
/**
|
|
1346
|
-
*
|
|
1347
|
-
* This will be called before navigating to the location specified by `href`.
|
|
1348
|
-
*
|
|
1349
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event
|
|
1406
|
+
* A callback fired when the link is activated, before navigating to the location specified by `href`. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).
|
|
1350
1407
|
*/
|
|
1351
1408
|
onClick?: (event: Event) => void;
|
|
1352
1409
|
}
|
|
1353
1410
|
export interface InteractionProps {
|
|
1354
1411
|
/**
|
|
1355
|
-
* ID of
|
|
1356
|
-
*
|
|
1357
|
-
* See `command` for how to control the behavior of the target.
|
|
1358
|
-
*
|
|
1359
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor
|
|
1412
|
+
* The ID of the component to control when this component is activated. Pair with the `command` property to specify what action to perform on the target component. Learn more about the [`commandFor` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#commandfor).
|
|
1360
1413
|
*/
|
|
1361
1414
|
commandFor?: string;
|
|
1362
1415
|
/**
|
|
1363
|
-
* Sets the action the `
|
|
1416
|
+
* Sets the action the [`command`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command) should take when this component is activated. Available options:
|
|
1364
1417
|
*
|
|
1365
|
-
*
|
|
1418
|
+
* - `'--auto'`: Performs the default action appropriate for the target component.
|
|
1419
|
+
* - `'--show'`: Displays the target component if it's currently hidden.
|
|
1420
|
+
* - `'--hide'`: Conceals the target component from view.
|
|
1421
|
+
* - `'--toggle'`: Alternates the target component between visible and hidden states.
|
|
1422
|
+
* - `'--copy'`: Copies the target clipboard item.
|
|
1366
1423
|
*
|
|
1367
|
-
*
|
|
1368
|
-
* - `--show`: shows the target component.
|
|
1369
|
-
* - `--hide`: hides the target component.
|
|
1370
|
-
* - `--toggle`: toggles the target component.
|
|
1371
|
-
* - `--copy`: copies the target ClipboardItem.
|
|
1424
|
+
* The supported actions vary by target component type.
|
|
1372
1425
|
*
|
|
1373
1426
|
* @default '--auto'
|
|
1374
|
-
*
|
|
1375
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#command
|
|
1376
1427
|
*/
|
|
1377
1428
|
command?: "--auto" | "--show" | "--hide" | "--toggle" | "--copy";
|
|
1378
1429
|
/**
|
|
1379
|
-
* ID of
|
|
1430
|
+
* The ID of the component to show when users hover over or focus on this component. Pair with a target component that supports interest-based interactions. Learn more about the [interestFor attribute](https://open-ui.org/components/interest-invokers.explainer/#the-pitch-in-code).
|
|
1380
1431
|
*/
|
|
1381
1432
|
interestFor?: string;
|
|
1382
1433
|
}
|
|
@@ -1384,58 +1435,62 @@ export interface BaseClickableProps extends ButtonBehaviorProps, LinkBehaviorPro
|
|
|
1384
1435
|
}
|
|
1385
1436
|
interface ButtonProps$1 extends GlobalProps, BaseClickableProps {
|
|
1386
1437
|
/**
|
|
1387
|
-
* A label that describes the purpose or
|
|
1388
|
-
*
|
|
1389
|
-
* Use this when using only an icon or the Button text is not enough context
|
|
1390
|
-
* for users using assistive technologies.
|
|
1438
|
+
* A label that describes the purpose or content of the button for users of assistive technologies such as screen readers. Use this when the visible content alone doesn't provide enough context.
|
|
1391
1439
|
*/
|
|
1392
1440
|
accessibilityLabel?: string;
|
|
1393
1441
|
/**
|
|
1394
|
-
* The content
|
|
1442
|
+
* The content displayed within the button component.
|
|
1395
1443
|
*/
|
|
1396
1444
|
children?: ComponentChildren;
|
|
1397
1445
|
/**
|
|
1398
|
-
*
|
|
1446
|
+
* An icon displayed inside the button, typically positioned before the button text.
|
|
1399
1447
|
*
|
|
1400
1448
|
* @default ''
|
|
1401
1449
|
*/
|
|
1402
1450
|
icon?: IconType | AnyString;
|
|
1403
1451
|
/**
|
|
1404
|
-
* The
|
|
1452
|
+
* The inline width of the button component.
|
|
1405
1453
|
*
|
|
1406
|
-
* - `auto`:
|
|
1407
|
-
* - `fill`:
|
|
1408
|
-
* - `fit-content`:
|
|
1454
|
+
* - `'auto'`: The size depends on the surface and context.
|
|
1455
|
+
* - `'fill'`: The button takes up 100% of the available inline size.
|
|
1456
|
+
* - `'fit-content'`: The button takes up the minimum inline size required to fit its content.
|
|
1409
1457
|
*
|
|
1410
1458
|
* @default 'auto'
|
|
1411
1459
|
*/
|
|
1412
1460
|
inlineSize?: "auto" | "fill" | "fit-content";
|
|
1413
1461
|
/**
|
|
1414
|
-
*
|
|
1462
|
+
* The visual style variant of the button component, which controls its prominence and emphasis.
|
|
1463
|
+
*
|
|
1464
|
+
* - `'auto'`: Automatically determined by the button's context.
|
|
1465
|
+
* - `'primary'`: High-emphasis style for the main action.
|
|
1466
|
+
* - `'secondary'`: Medium-emphasis style for supporting actions.
|
|
1467
|
+
* - `'tertiary'`: Low-emphasis style for less prominent actions.
|
|
1415
1468
|
*
|
|
1416
|
-
* @default 'auto'
|
|
1469
|
+
* @default 'auto'
|
|
1417
1470
|
*/
|
|
1418
1471
|
variant?: "auto" | "primary" | "secondary" | "tertiary";
|
|
1419
1472
|
/**
|
|
1420
|
-
*
|
|
1473
|
+
* The semantic meaning and color treatment of the button.
|
|
1474
|
+
*
|
|
1475
|
+
* - `'auto'`: Automatically determined based on context.
|
|
1476
|
+
* - `'neutral'`: General information without specific intent.
|
|
1477
|
+
* - `'critical'`: Urgent problems or destructive actions.
|
|
1421
1478
|
*
|
|
1422
1479
|
* @default 'auto'
|
|
1423
1480
|
*/
|
|
1424
1481
|
tone?: ToneKeyword;
|
|
1425
1482
|
/**
|
|
1426
|
-
*
|
|
1427
|
-
* It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
1428
|
-
* [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
|
|
1483
|
+
* The language of the button's text content. Use this when the button text is in a different language than the rest of the page, so assistive technologies can invoke the correct pronunciation. See the [reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (`Subtag` label).
|
|
1429
1484
|
*/
|
|
1430
1485
|
lang?: string;
|
|
1431
1486
|
}
|
|
1432
1487
|
export interface BaseInputProps {
|
|
1433
1488
|
/**
|
|
1434
|
-
*
|
|
1489
|
+
* The name attribute for the field, used to identify the field's value when the form is submitted. Must be unique within the nearest containing form.
|
|
1435
1490
|
*/
|
|
1436
1491
|
name?: string;
|
|
1437
1492
|
/**
|
|
1438
|
-
*
|
|
1493
|
+
* Whether the field is disabled, preventing any user interaction.
|
|
1439
1494
|
*
|
|
1440
1495
|
* @default false
|
|
1441
1496
|
*/
|
|
@@ -1443,15 +1498,15 @@ export interface BaseInputProps {
|
|
|
1443
1498
|
}
|
|
1444
1499
|
export interface InputProps extends BaseInputProps {
|
|
1445
1500
|
/**
|
|
1446
|
-
*
|
|
1501
|
+
* A callback fired when the user has **finished editing** a field, such as when they blur the field or press Enter.
|
|
1447
1502
|
*
|
|
1448
1503
|
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event
|
|
1449
1504
|
*/
|
|
1450
1505
|
onChange?: (event: Event) => void;
|
|
1451
1506
|
/**
|
|
1452
|
-
*
|
|
1507
|
+
* A callback fired when the user makes any changes in the field, such as typing a character.
|
|
1453
1508
|
*
|
|
1454
|
-
*
|
|
1509
|
+
* Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
|
|
1455
1510
|
*/
|
|
1456
1511
|
onInput?: (event: Event) => void;
|
|
1457
1512
|
/**
|
|
@@ -1459,7 +1514,7 @@ export interface InputProps extends BaseInputProps {
|
|
|
1459
1514
|
*/
|
|
1460
1515
|
value?: string;
|
|
1461
1516
|
/**
|
|
1462
|
-
* The
|
|
1517
|
+
* The initial value of the field when it first loads. Unlike `placeholder`, this is a real value that the user can edit and that gets submitted with the form. Once the user starts typing, their input replaces this value.
|
|
1463
1518
|
*
|
|
1464
1519
|
* @implementation `defaultValue` reflects to the `value` attribute.
|
|
1465
1520
|
*/
|
|
@@ -1467,19 +1522,19 @@ export interface InputProps extends BaseInputProps {
|
|
|
1467
1522
|
}
|
|
1468
1523
|
export interface MultipleInputProps extends BaseInputProps {
|
|
1469
1524
|
/**
|
|
1470
|
-
*
|
|
1525
|
+
* A callback fired when the user has selected one or more options.
|
|
1471
1526
|
*
|
|
1472
|
-
*
|
|
1527
|
+
* Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).
|
|
1473
1528
|
*/
|
|
1474
1529
|
onChange?: (event: Event) => void;
|
|
1475
1530
|
/**
|
|
1476
|
-
*
|
|
1531
|
+
* A callback fired when the user selects or deselects options.
|
|
1477
1532
|
*
|
|
1478
|
-
*
|
|
1533
|
+
* Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
|
|
1479
1534
|
*/
|
|
1480
1535
|
onInput?: (event: Event) => void;
|
|
1481
1536
|
/**
|
|
1482
|
-
* An array of
|
|
1537
|
+
* An array of `value` attributes for the currently selected options.
|
|
1483
1538
|
*
|
|
1484
1539
|
* This is a convenience prop for setting the `selected` prop on child options.
|
|
1485
1540
|
*/
|
|
@@ -1487,11 +1542,11 @@ export interface MultipleInputProps extends BaseInputProps {
|
|
|
1487
1542
|
}
|
|
1488
1543
|
export interface FileInputProps extends BaseInputProps {
|
|
1489
1544
|
/**
|
|
1490
|
-
*
|
|
1545
|
+
* A callback fired when the user has finished selecting one or more files.
|
|
1491
1546
|
*/
|
|
1492
1547
|
onChange?: (event: Event) => void;
|
|
1493
1548
|
/**
|
|
1494
|
-
*
|
|
1549
|
+
* A callback fired when the user makes any changes to the file selection.
|
|
1495
1550
|
*/
|
|
1496
1551
|
onInput?: (event: Event) => void;
|
|
1497
1552
|
/**
|
|
@@ -1516,8 +1571,7 @@ export interface FileInputProps extends BaseInputProps {
|
|
|
1516
1571
|
}
|
|
1517
1572
|
export interface FieldErrorProps {
|
|
1518
1573
|
/**
|
|
1519
|
-
*
|
|
1520
|
-
* to communicate problems that have to be resolved immediately.
|
|
1574
|
+
* An error message displayed below the field to indicate validation problems. When set, the field is styled with error indicators and the message is announced to screen readers.
|
|
1521
1575
|
*/
|
|
1522
1576
|
error?: string;
|
|
1523
1577
|
}
|
|
@@ -1532,7 +1586,7 @@ export interface BasicFieldProps extends FieldErrorProps, LabelAccessibilityVisi
|
|
|
1532
1586
|
*/
|
|
1533
1587
|
required?: boolean;
|
|
1534
1588
|
/**
|
|
1535
|
-
*
|
|
1589
|
+
* The text displayed as the field label, which identifies the purpose of the field to users. This label is associated with the field for accessibility and helps users understand what information to provide.
|
|
1536
1590
|
*/
|
|
1537
1591
|
label?: string;
|
|
1538
1592
|
}
|
|
@@ -1548,13 +1602,13 @@ export interface FieldDetailsProps {
|
|
|
1548
1602
|
}
|
|
1549
1603
|
export interface FieldProps extends BasicFieldProps, InputProps, FocusEventProps, FieldDetailsProps {
|
|
1550
1604
|
/**
|
|
1551
|
-
*
|
|
1605
|
+
* The placeholder text displayed in the field when it's empty, providing a hint about the expected input format or value.
|
|
1552
1606
|
*/
|
|
1553
1607
|
placeholder?: string;
|
|
1554
1608
|
}
|
|
1555
1609
|
export interface BaseTextFieldProps extends FieldProps {
|
|
1556
1610
|
/**
|
|
1557
|
-
*
|
|
1611
|
+
* Whether the field is read-only and can't be edited. Read-only fields remain focusable and their content is announced by screen readers.
|
|
1558
1612
|
*
|
|
1559
1613
|
* @default false
|
|
1560
1614
|
*/
|
|
@@ -1566,7 +1620,7 @@ export interface FieldDecorationProps {
|
|
|
1566
1620
|
*
|
|
1567
1621
|
* This is useful for displaying an implied part of the value, such as "@shopify.com", or "%".
|
|
1568
1622
|
*
|
|
1569
|
-
* This
|
|
1623
|
+
* This can't be edited by the user, and it isn't included in the value of the field.
|
|
1570
1624
|
*
|
|
1571
1625
|
* It may not be displayed until the user has interacted with the input.
|
|
1572
1626
|
* For example, an inline label may take the place of the suffix until the user focuses the input.
|
|
@@ -1579,7 +1633,7 @@ export interface FieldDecorationProps {
|
|
|
1579
1633
|
*
|
|
1580
1634
|
* This is useful for displaying an implied part of the value, such as "https://" or "+353".
|
|
1581
1635
|
*
|
|
1582
|
-
* This
|
|
1636
|
+
* This can't be edited by the user, and it isn't included in the value of the field.
|
|
1583
1637
|
*
|
|
1584
1638
|
* It may not be displayed until the user has interacted with the input.
|
|
1585
1639
|
* For example, an inline label may take the place of the prefix until the user focuses the input.
|
|
@@ -1604,8 +1658,7 @@ export interface NumberConstraintsProps {
|
|
|
1604
1658
|
* The highest decimal or integer to be accepted for the field.
|
|
1605
1659
|
* When used with `step` the value will round down to the max number.
|
|
1606
1660
|
*
|
|
1607
|
-
* Note: a user
|
|
1608
|
-
* the max. It is up to the developer to add appropriate validation.
|
|
1661
|
+
* Note: a user can still use the keyboard to input a number higher than the max. It's up to the developer to add appropriate validation.
|
|
1609
1662
|
*
|
|
1610
1663
|
* @default Infinity
|
|
1611
1664
|
*/
|
|
@@ -1614,8 +1667,7 @@ export interface NumberConstraintsProps {
|
|
|
1614
1667
|
* The lowest decimal or integer to be accepted for the field.
|
|
1615
1668
|
* When used with `step` the value will round up to the min number.
|
|
1616
1669
|
*
|
|
1617
|
-
* Note: a user
|
|
1618
|
-
* the min. It is up to the developer to add appropriate validation.
|
|
1670
|
+
* Note: a user can still use the keyboard to input a number lower than the min. It's up to the developer to add appropriate validation.
|
|
1619
1671
|
*
|
|
1620
1672
|
* @default -Infinity
|
|
1621
1673
|
*/
|
|
@@ -1632,10 +1684,9 @@ export interface NumberConstraintsProps {
|
|
|
1632
1684
|
/**
|
|
1633
1685
|
* Sets the type of controls displayed in the field.
|
|
1634
1686
|
*
|
|
1635
|
-
* - `
|
|
1636
|
-
* Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value
|
|
1637
|
-
* - `none`:
|
|
1638
|
-
* - `auto`: the presence of the controls depends on the surface and context.
|
|
1687
|
+
* - `'auto'`: The presence of the controls depends on the surface and context.
|
|
1688
|
+
* - `'stepper'`: Displays buttons to increase or decrease the value by the stepping interval defined in the `step` property. Appropriate mouse and [keyboard interactions](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/spinbutton_role#keyboard_interactions) to control the value are enabled.
|
|
1689
|
+
* - `'none'`: No controls are displayed and users must input the value manually. Arrow keys and scroll wheels can’t be used either to avoid accidental changes.
|
|
1639
1690
|
*
|
|
1640
1691
|
* @default 'auto'
|
|
1641
1692
|
*/
|
|
@@ -1649,7 +1700,7 @@ export interface MinMaxLengthProps {
|
|
|
1649
1700
|
*/
|
|
1650
1701
|
maxLength?: number;
|
|
1651
1702
|
/**
|
|
1652
|
-
* Specifies the
|
|
1703
|
+
* Specifies the minimum number of characters allowed.
|
|
1653
1704
|
*
|
|
1654
1705
|
* @default 0
|
|
1655
1706
|
*/
|
|
@@ -1662,7 +1713,7 @@ export interface BaseSelectableProps {
|
|
|
1662
1713
|
*/
|
|
1663
1714
|
accessibilityLabel?: string;
|
|
1664
1715
|
/**
|
|
1665
|
-
*
|
|
1716
|
+
* Whether the control is disabled, preventing any user interaction.
|
|
1666
1717
|
*
|
|
1667
1718
|
* @default false
|
|
1668
1719
|
*/
|
|
@@ -1674,13 +1725,13 @@ export interface BaseSelectableProps {
|
|
|
1674
1725
|
}
|
|
1675
1726
|
export interface BaseOptionProps extends BaseSelectableProps {
|
|
1676
1727
|
/**
|
|
1677
|
-
* Whether the control is
|
|
1728
|
+
* Whether the control is currently selected.
|
|
1678
1729
|
*
|
|
1679
1730
|
* @default false
|
|
1680
1731
|
*/
|
|
1681
1732
|
selected?: boolean;
|
|
1682
1733
|
/**
|
|
1683
|
-
* Whether the control is
|
|
1734
|
+
* Whether the control is selected by default.
|
|
1684
1735
|
*
|
|
1685
1736
|
* @implementation `defaultSelected` reflects to the `selected` attribute.
|
|
1686
1737
|
*
|
|
@@ -1690,17 +1741,17 @@ export interface BaseOptionProps extends BaseSelectableProps {
|
|
|
1690
1741
|
}
|
|
1691
1742
|
export interface BaseCheckableProps extends BaseSelectableProps, InteractionProps {
|
|
1692
1743
|
/**
|
|
1693
|
-
*
|
|
1744
|
+
* The text displayed as the control label, which identifies the purpose of the control to users. This label is associated with the control for accessibility.
|
|
1694
1745
|
*/
|
|
1695
1746
|
label?: string;
|
|
1696
1747
|
/**
|
|
1697
|
-
* Whether the control is
|
|
1748
|
+
* Whether the control is currently checked.
|
|
1698
1749
|
*
|
|
1699
1750
|
* @default false
|
|
1700
1751
|
*/
|
|
1701
1752
|
checked?: boolean;
|
|
1702
1753
|
/**
|
|
1703
|
-
* Whether the control is
|
|
1754
|
+
* Whether the control is checked by default.
|
|
1704
1755
|
*
|
|
1705
1756
|
* @implementation `defaultChecked` reflects to the `checked` attribute.
|
|
1706
1757
|
*
|
|
@@ -1708,8 +1759,7 @@ export interface BaseCheckableProps extends BaseSelectableProps, InteractionProp
|
|
|
1708
1759
|
*/
|
|
1709
1760
|
defaultChecked?: boolean;
|
|
1710
1761
|
/**
|
|
1711
|
-
*
|
|
1712
|
-
* containing `Form` component.
|
|
1762
|
+
* The name attribute for the control, used to identify its value when the form is submitted. Must be unique within the nearest containing form.
|
|
1713
1763
|
*/
|
|
1714
1764
|
name?: string;
|
|
1715
1765
|
/**
|
|
@@ -1761,21 +1811,25 @@ interface CheckboxProps$1 extends GlobalProps, BaseCheckableProps, FieldErrorPro
|
|
|
1761
1811
|
}
|
|
1762
1812
|
export interface ChipProps$1 {
|
|
1763
1813
|
/**
|
|
1764
|
-
* The
|
|
1814
|
+
* The text label displayed within the chip, which identifies the chip's value or category to users.
|
|
1765
1815
|
*/
|
|
1766
1816
|
children?: ComponentChildren;
|
|
1767
1817
|
/**
|
|
1768
|
-
*
|
|
1818
|
+
* An optional graphic displayed at the start of the chip, such as an icon to visually reinforce the chip's label.
|
|
1769
1819
|
*
|
|
1770
1820
|
* @implementation Only `s-icon` is supported.
|
|
1771
1821
|
*/
|
|
1772
1822
|
graphic?: ComponentChildren;
|
|
1773
1823
|
/**
|
|
1774
|
-
* A label that describes the purpose or contents of the
|
|
1824
|
+
* A label that describes the purpose or contents of the chip. It will be read to users using assistive technologies such as screen readers.
|
|
1775
1825
|
*/
|
|
1776
1826
|
accessibilityLabel?: string;
|
|
1777
1827
|
/**
|
|
1778
|
-
*
|
|
1828
|
+
* The color emphasis level that controls visual intensity.
|
|
1829
|
+
*
|
|
1830
|
+
* - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.
|
|
1831
|
+
* - `base`: Primary color for body text, standard UI elements, and general content with good readability.
|
|
1832
|
+
* - `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.
|
|
1779
1833
|
*
|
|
1780
1834
|
* @default 'base'
|
|
1781
1835
|
*/
|
|
@@ -1806,13 +1860,13 @@ interface ChoiceProps$1 extends GlobalProps, BaseOptionProps {
|
|
|
1806
1860
|
*/
|
|
1807
1861
|
details?: ComponentChildren;
|
|
1808
1862
|
/**
|
|
1809
|
-
*
|
|
1863
|
+
* Whether this choice is associated with the error state of the parent choice list. When `true`, the choice is visually marked as having an error.
|
|
1810
1864
|
*
|
|
1811
1865
|
* @default false
|
|
1812
1866
|
*/
|
|
1813
1867
|
error?: boolean;
|
|
1814
1868
|
/**
|
|
1815
|
-
*
|
|
1869
|
+
* Additional text or elements displayed below the choice label, providing extra context or detail to help users make a selection.
|
|
1816
1870
|
*/
|
|
1817
1871
|
secondaryContent?: ComponentChildren;
|
|
1818
1872
|
/**
|
|
@@ -1836,7 +1890,7 @@ interface ChoiceListProps$1 extends GlobalProps, Pick<BasicFieldProps, "label" |
|
|
|
1836
1890
|
*/
|
|
1837
1891
|
children?: ComponentChildren;
|
|
1838
1892
|
/**
|
|
1839
|
-
*
|
|
1893
|
+
* Whether the field is disabled, preventing any user interaction.
|
|
1840
1894
|
*
|
|
1841
1895
|
* `disabled` on any child choices is ignored when this is true.
|
|
1842
1896
|
*
|
|
@@ -1869,7 +1923,7 @@ interface ClickableProps$1 extends GlobalProps, BaseBoxProps, BaseClickableProps
|
|
|
1869
1923
|
/**
|
|
1870
1924
|
* Disables the clickable, meaning it cannot be clicked or receive focus.
|
|
1871
1925
|
*
|
|
1872
|
-
* In this state,
|
|
1926
|
+
* In this state, the `click` event will not fire.
|
|
1873
1927
|
* If the click event originates from a child element, the event will immediately stop propagating from this element.
|
|
1874
1928
|
*
|
|
1875
1929
|
* However, items within the clickable can still receive focus and be interacted with.
|
|
@@ -1879,9 +1933,9 @@ interface ClickableProps$1 extends GlobalProps, BaseBoxProps, BaseClickableProps
|
|
|
1879
1933
|
*/
|
|
1880
1934
|
disabled?: BaseClickableProps["disabled"];
|
|
1881
1935
|
/**
|
|
1882
|
-
*
|
|
1883
|
-
*
|
|
1884
|
-
* [
|
|
1936
|
+
* The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
1937
|
+
*
|
|
1938
|
+
* 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).
|
|
1885
1939
|
*
|
|
1886
1940
|
* @default ''
|
|
1887
1941
|
*/
|
|
@@ -1889,23 +1943,21 @@ interface ClickableProps$1 extends GlobalProps, BaseBoxProps, BaseClickableProps
|
|
|
1889
1943
|
}
|
|
1890
1944
|
interface ClickableChipProps$1 extends ChipProps$1, GlobalProps {
|
|
1891
1945
|
/**
|
|
1892
|
-
*
|
|
1946
|
+
* A callback fired when the chip is clicked. Learn more about the [click event](https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event).
|
|
1893
1947
|
*/
|
|
1894
1948
|
onClick?: (event: Event) => void;
|
|
1895
1949
|
/**
|
|
1896
|
-
* The URL to link to.
|
|
1897
|
-
*
|
|
1898
|
-
* - If set, it will navigate to the location specified by `href` after executing the `click` event.
|
|
1950
|
+
* The URL to link to. When set, the chip navigates to the specified location after the `click` event fires.
|
|
1899
1951
|
*/
|
|
1900
1952
|
href?: string;
|
|
1901
1953
|
/**
|
|
1902
|
-
* Whether the chip
|
|
1954
|
+
* Whether the chip displays a remove button, allowing users to dismiss it. When `true`, clicking the remove button fires the `remove` event.
|
|
1903
1955
|
*
|
|
1904
1956
|
* @default false
|
|
1905
1957
|
*/
|
|
1906
1958
|
removable?: boolean;
|
|
1907
1959
|
/**
|
|
1908
|
-
*
|
|
1960
|
+
* A callback fired when the chip is removed by the user clicking the remove button.
|
|
1909
1961
|
*/
|
|
1910
1962
|
onRemove?: (event: Event) => void;
|
|
1911
1963
|
/**
|
|
@@ -1921,7 +1973,7 @@ interface ClickableChipProps$1 extends ChipProps$1, GlobalProps {
|
|
|
1921
1973
|
*/
|
|
1922
1974
|
hidden?: boolean;
|
|
1923
1975
|
/**
|
|
1924
|
-
*
|
|
1976
|
+
* A callback fired when the chip has fully hidden after a removal animation.
|
|
1925
1977
|
*
|
|
1926
1978
|
* The `hidden` property will be `true` when this event fires.
|
|
1927
1979
|
*
|
|
@@ -1931,7 +1983,7 @@ interface ClickableChipProps$1 extends ChipProps$1, GlobalProps {
|
|
|
1931
1983
|
*/
|
|
1932
1984
|
onAfterHide?: (event: Event) => void;
|
|
1933
1985
|
/**
|
|
1934
|
-
* Disables the chip,
|
|
1986
|
+
* Disables the chip, preventing all user interaction including clicks and removal. Disabled chips are visually dimmed to indicate they are not interactive.
|
|
1935
1987
|
*
|
|
1936
1988
|
* @default false
|
|
1937
1989
|
*/
|
|
@@ -1955,7 +2007,7 @@ interface ClipboardItemProps$1 extends GlobalProps {
|
|
|
1955
2007
|
}
|
|
1956
2008
|
export interface AutocompleteProps<AutocompleteField extends AnyAutocompleteField> {
|
|
1957
2009
|
/**
|
|
1958
|
-
* A hint
|
|
2010
|
+
* A hint about the intended content of the field for browser autofill.
|
|
1959
2011
|
*
|
|
1960
2012
|
* When set to `on` (the default), this property indicates that the field should support
|
|
1961
2013
|
* autofill, but you do not have any more semantic information on the intended
|
|
@@ -1967,12 +2019,9 @@ export interface AutocompleteProps<AutocompleteField extends AnyAutocompleteFiel
|
|
|
1967
2019
|
* Alternatively, you can provide value which describes the
|
|
1968
2020
|
* specific data you would like to be entered into this field during autofill.
|
|
1969
2021
|
*
|
|
1970
|
-
*
|
|
2022
|
+
* Learn more about the set of [autocomplete values](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens) supported in browsers.
|
|
1971
2023
|
*
|
|
1972
|
-
* @default '
|
|
1973
|
-
* @default 'email' for EmailField
|
|
1974
|
-
* @default 'url' for URLField
|
|
1975
|
-
* @default 'on' for everything else
|
|
2024
|
+
* @default 'on'
|
|
1976
2025
|
*/
|
|
1977
2026
|
autocomplete?: AutocompleteField | `${AutocompleteSection} ${AutocompleteField}` | `${AutocompleteGroup} ${AutocompleteField}` | `${AutocompleteSection} ${AutocompleteGroup} ${AutocompleteField}` | "on" | "off";
|
|
1978
2027
|
}
|
|
@@ -1994,31 +2043,29 @@ export type AutocompleteGroup = "shipping" | "billing";
|
|
|
1994
2043
|
export type AutocompleteAddressGroup = "fax" | "home" | "mobile" | "pager";
|
|
1995
2044
|
export type AnyAutocompleteField = "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" | "address-line1" | "address-line2" | "address-line3" | "country-name" | "country" | "current-password" | "email" | "family-name" | "given-name" | "honorific-prefix" | "honorific-suffix" | "language" | "name" | "new-password" | "nickname" | "one-time-code" | "organization-title" | "organization" | "photo" | "postal-code" | "sex" | "street-address" | "transaction-amount" | "transaction-currency" | "url" | "username" | "bday-day" | "bday-month" | "bday-year" | "bday" | "cc-additional-name" | "cc-expiry-month" | "cc-expiry-year" | "cc-expiry" | "cc-family-name" | "cc-given-name" | "cc-name" | "cc-number" | "cc-csc" | "cc-type" | `${AutocompleteAddressGroup} email` | "impp" | `${AutocompleteAddressGroup} impp` | "tel" | "tel-area-code" | "tel-country-code" | "tel-extension" | "tel-local-prefix" | "tel-local-suffix" | "tel-local" | "tel-national" | `${AutocompleteAddressGroup} tel` | `${AutocompleteAddressGroup} tel-area-code` | `${AutocompleteAddressGroup} tel-country-code` | `${AutocompleteAddressGroup} tel-extension` | `${AutocompleteAddressGroup} tel-local-prefix` | `${AutocompleteAddressGroup} tel-local-suffix` | `${AutocompleteAddressGroup} tel-local` | `${AutocompleteAddressGroup} tel-national`;
|
|
1996
2045
|
export type TextAutocompleteField = ExtractStrict<AnyAutocompleteField, "additional-name" | "address-level1" | "address-level2" | "address-level3" | "address-level4" | "address-line1" | "address-line2" | "address-line3" | "country-name" | "country" | "family-name" | "given-name" | "honorific-prefix" | "honorific-suffix" | "language" | "name" | "nickname" | "one-time-code" | "organization-title" | "organization" | "postal-code" | "sex" | "street-address" | "transaction-currency" | "username" | "cc-name" | "cc-given-name" | "cc-additional-name" | "cc-family-name" | "cc-type">;
|
|
2046
|
+
/**
|
|
2047
|
+
* The policy for which buyer consent is being collected. Used by the [consent checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-checkbox) and [consent phone field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/consent-phone-field) components to identify the type of marketing permission requested.
|
|
2048
|
+
* @publicDocs
|
|
2049
|
+
*/
|
|
1997
2050
|
export type ConsentPolicy = "sms-marketing";
|
|
1998
2051
|
interface ConsentCheckboxProps$1 extends GlobalProps, CheckboxProps$1 {
|
|
1999
2052
|
/**
|
|
2000
|
-
* The policy for which user consent is being collected
|
|
2001
|
-
*
|
|
2002
|
-
* `sms-marketing`: Represents the policy for SMS marketing consent.
|
|
2053
|
+
* The policy for which user consent is being collected.
|
|
2003
2054
|
*/
|
|
2004
2055
|
policy?: ConsentPolicy;
|
|
2005
2056
|
}
|
|
2006
2057
|
export type PhoneAutocompleteField = ExtractStrict<AnyAutocompleteField, "tel" | "tel-area-code" | "tel-country-code" | "tel-extension" | "tel-local-prefix" | "tel-local-suffix" | "tel-local" | "tel-national" | `${AutocompleteAddressGroup} tel` | `${AutocompleteAddressGroup} tel-area-code` | `${AutocompleteAddressGroup} tel-country-code` | `${AutocompleteAddressGroup} tel-extension` | `${AutocompleteAddressGroup} tel-local-prefix` | `${AutocompleteAddressGroup} tel-local-suffix` | `${AutocompleteAddressGroup} tel-local` | `${AutocompleteAddressGroup} tel-national`>;
|
|
2007
2058
|
interface PhoneFieldProps$1 extends GlobalProps, BaseTextFieldProps, Pick<FieldDecorationProps, "accessory">, AutocompleteProps<PhoneAutocompleteField> {
|
|
2008
2059
|
/**
|
|
2009
|
-
* The type of number to collect.
|
|
2060
|
+
* The type of phone number to collect. Specific styling may be applied to each type to provide extra guidance to users. No additional validation is performed based on the type.
|
|
2010
2061
|
*
|
|
2011
|
-
*
|
|
2012
|
-
*
|
|
2013
|
-
* @default '' meaning no specific kind of phone number
|
|
2062
|
+
* @default ''
|
|
2014
2063
|
*/
|
|
2015
2064
|
type?: "mobile" | "";
|
|
2016
2065
|
}
|
|
2017
2066
|
interface ConsentPhoneFieldProps$1 extends GlobalProps, PhoneFieldProps$1 {
|
|
2018
2067
|
/**
|
|
2019
|
-
* The policy for which user consent is being collected
|
|
2020
|
-
*
|
|
2021
|
-
* `sms-marketing`: Represents the policy for SMS marketing consent.
|
|
2068
|
+
* The policy for which user consent is being collected.
|
|
2022
2069
|
*/
|
|
2023
2070
|
policy?: ConsentPolicy;
|
|
2024
2071
|
}
|
|
@@ -2056,9 +2103,7 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps {
|
|
|
2056
2103
|
*/
|
|
2057
2104
|
type?: "single" | "multiple" | "range";
|
|
2058
2105
|
/**
|
|
2059
|
-
*
|
|
2060
|
-
*
|
|
2061
|
-
* A comma-separated list of dates, date ranges. Whitespace is allowed after commas.
|
|
2106
|
+
* Restricts which dates the user can select. Accepts a comma-separated list of dates and date ranges. Whitespace is allowed after commas.
|
|
2062
2107
|
*
|
|
2063
2108
|
* The default `''` allows all dates.
|
|
2064
2109
|
*
|
|
@@ -2109,7 +2154,7 @@ interface DatePickerProps$1 extends GlobalProps, InputProps, FocusEventProps {
|
|
|
2109
2154
|
*/
|
|
2110
2155
|
disallow?: string;
|
|
2111
2156
|
/**
|
|
2112
|
-
*
|
|
2157
|
+
* Restricts which days of the week the user can select. Only dates that fall on an allowed day AND pass the `allow`/`disallow` filters are selectable. For example, setting `allowedDays` to `'mon, wed, fri'` with `allow` set to `'2024-06'` restricts selection to Mondays, Wednesdays, and Fridays in June 2024.
|
|
2113
2158
|
*
|
|
2114
2159
|
* A comma-separated list of days. Whitespace is allowed after commas.
|
|
2115
2160
|
*
|
|
@@ -2189,47 +2234,42 @@ interface DateFieldProps$1 extends GlobalProps, BaseTextFieldProps, Pick<DatePic
|
|
|
2189
2234
|
*
|
|
2190
2235
|
* Disallowed dates are considered invalid.
|
|
2191
2236
|
*
|
|
2192
|
-
*
|
|
2193
|
-
*
|
|
2194
|
-
* The field is **not** validated on every change to the input. Once the buyer has signalled that
|
|
2195
|
-
* they have finished editing the field (typically, by blurring the field), the field gets validated and the callback is run if the value is invalid.
|
|
2237
|
+
* This callback fires only when the user finishes editing the date, right after the `change` callback.
|
|
2238
|
+
* The field isn't validated on every change to the input. Once the user has finished editing the field (typically by blurring it), the field is validated and the callback fires if the value is invalid.
|
|
2196
2239
|
*/
|
|
2197
2240
|
onInvalid?: (event: Event) => void;
|
|
2198
2241
|
}
|
|
2199
2242
|
export type DateAutocompleteField = ExtractStrict<AnyAutocompleteField, "bday" | "bday-day" | "bday-month" | "bday-year" | "cc-expiry" | "cc-expiry-month" | "cc-expiry-year">;
|
|
2200
2243
|
interface DetailsProps$1 extends GlobalProps, ToggleEventProps {
|
|
2201
2244
|
/**
|
|
2202
|
-
* The content
|
|
2245
|
+
* The content displayed within the details component, which creates a collapsible disclosure widget.
|
|
2203
2246
|
*
|
|
2204
|
-
*
|
|
2247
|
+
* Learn more about the [details element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details).
|
|
2205
2248
|
*/
|
|
2206
2249
|
children?: ComponentChildren;
|
|
2207
2250
|
/**
|
|
2208
|
-
*
|
|
2209
|
-
*
|
|
2210
|
-
* This can be used to create multiple named disclosure boxes that where only one can be open at a time.
|
|
2251
|
+
* The `name` attribute for the element. Use this to create multiple named disclosure groups where only one can be open at a time.
|
|
2211
2252
|
*
|
|
2212
|
-
*
|
|
2253
|
+
* Learn more about [multiple named disclosure boxes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details#multiple_named_disclosure_boxes).
|
|
2213
2254
|
*/
|
|
2214
2255
|
name?: string;
|
|
2215
2256
|
/**
|
|
2216
|
-
* Whether the element is open.
|
|
2217
|
-
*
|
|
2218
|
-
* This does not reflect to any attribute.
|
|
2257
|
+
* Whether the element is currently open and showing its content. Use this for controlled behavior where you manage the open state yourself.
|
|
2219
2258
|
*
|
|
2220
2259
|
* @default false
|
|
2221
2260
|
*/
|
|
2222
2261
|
open?: boolean;
|
|
2223
2262
|
/**
|
|
2224
|
-
*
|
|
2225
|
-
*
|
|
2226
|
-
* This reflects to the `open` attribute.
|
|
2263
|
+
* Whether the element should be open when it first renders. Use this for uncontrolled behavior where the component manages its own open state after the initial render.
|
|
2227
2264
|
*
|
|
2228
2265
|
* @default false
|
|
2229
2266
|
*/
|
|
2230
2267
|
defaultOpen?: boolean;
|
|
2231
2268
|
/**
|
|
2232
|
-
* Sets the transition between the
|
|
2269
|
+
* Sets the animation transition between the open and closed states.
|
|
2270
|
+
*
|
|
2271
|
+
* - `none`: Disables all transition animations.
|
|
2272
|
+
* - `auto`: Uses the default transition animation.
|
|
2233
2273
|
*
|
|
2234
2274
|
* @default 'auto'
|
|
2235
2275
|
*/
|
|
@@ -2237,13 +2277,20 @@ interface DetailsProps$1 extends GlobalProps, ToggleEventProps {
|
|
|
2237
2277
|
}
|
|
2238
2278
|
interface DividerProps$1 extends GlobalProps {
|
|
2239
2279
|
/**
|
|
2240
|
-
*
|
|
2280
|
+
* The orientation of the divider, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
|
|
2281
|
+
*
|
|
2282
|
+
* - `inline`: A horizontal divider that separates content stacked vertically.
|
|
2283
|
+
* - `block`: A vertical divider that separates content arranged horizontally.
|
|
2241
2284
|
*
|
|
2242
2285
|
* @default 'inline'
|
|
2243
2286
|
*/
|
|
2244
2287
|
direction?: "inline" | "block";
|
|
2245
2288
|
/**
|
|
2246
|
-
*
|
|
2289
|
+
* The visual emphasis of the divider's color.
|
|
2290
|
+
*
|
|
2291
|
+
* - `subdued`: A lighter divider for subtle separation.
|
|
2292
|
+
* - `base`: The standard divider color for most contexts.
|
|
2293
|
+
* - `strong`: A darker divider for stronger visual separation.
|
|
2247
2294
|
*
|
|
2248
2295
|
* @default 'base'
|
|
2249
2296
|
*/
|
|
@@ -2253,7 +2300,7 @@ interface DropZoneProps$1 extends GlobalProps, FileInputProps, BasicFieldProps {
|
|
|
2253
2300
|
/**
|
|
2254
2301
|
* A string representing the types of files that are accepted by the drop zone.
|
|
2255
2302
|
* This string is a comma-separated list of unique file type specifiers which can be one of the following:
|
|
2256
|
-
* - A file extension starting with a period (".") character (
|
|
2303
|
+
* - A file extension starting with a period (".") character (such as .jpg, .pdf, .doc)
|
|
2257
2304
|
* - A valid MIME type string with no extensions
|
|
2258
2305
|
*
|
|
2259
2306
|
* If omitted, all file types are accepted.
|
|
@@ -2311,29 +2358,31 @@ interface FormProps$1 extends GlobalProps {
|
|
|
2311
2358
|
*/
|
|
2312
2359
|
onReset?: (event: Event) => void;
|
|
2313
2360
|
}
|
|
2361
|
+
/**
|
|
2362
|
+
* The amount of space between child elements.
|
|
2363
|
+
*
|
|
2364
|
+
* - `none`: No spacing.
|
|
2365
|
+
* - `small-500`: The smallest spacing.
|
|
2366
|
+
* - `small-400` / `small-300` / `small-200` / `small-100` / `small`: Progressively larger small spacings.
|
|
2367
|
+
* - `base`: The standard spacing for most use cases.
|
|
2368
|
+
* - `large` / `large-100` / `large-200` / `large-300` / `large-400` / `large-500`: Progressively larger spacings.
|
|
2369
|
+
*/
|
|
2314
2370
|
export type SpacingKeyword = SizeKeyword | "none";
|
|
2315
2371
|
export interface GapProps {
|
|
2316
2372
|
/**
|
|
2317
|
-
*
|
|
2318
|
-
*
|
|
2319
|
-
* A single value applies to both axes.
|
|
2320
|
-
* A pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively.
|
|
2373
|
+
* The spacing between child elements. A single value applies to both the inline and block axes. A pair of space-separated values (for example, `large-100 large-500`) sets the inline and block axes independently.
|
|
2321
2374
|
*
|
|
2322
2375
|
* @default 'none'
|
|
2323
2376
|
*/
|
|
2324
2377
|
gap?: MaybeResponsive<MaybeTwoValuesShorthandProperty<SpacingKeyword>>;
|
|
2325
2378
|
/**
|
|
2326
|
-
*
|
|
2327
|
-
*
|
|
2328
|
-
* This overrides the row value of `gap`.
|
|
2379
|
+
* The spacing between child elements along the block axis (vertical in horizontal writing modes). Overrides the block-axis value set by `gap`.
|
|
2329
2380
|
*
|
|
2330
2381
|
* @default '' - meaning no override
|
|
2331
2382
|
*/
|
|
2332
2383
|
rowGap?: MaybeResponsive<SpacingKeyword | "">;
|
|
2333
2384
|
/**
|
|
2334
|
-
*
|
|
2335
|
-
*
|
|
2336
|
-
* This overrides the column value of `gap`.
|
|
2385
|
+
* The spacing between child elements along the inline axis (horizontal in horizontal writing modes). Overrides the inline-axis value set by `gap`.
|
|
2337
2386
|
*
|
|
2338
2387
|
* @default '' - meaning no override
|
|
2339
2388
|
*/
|
|
@@ -2344,108 +2393,80 @@ export type ContentDistribution = "space-between" | "space-around" | "space-even
|
|
|
2344
2393
|
export type ContentPosition = "center" | "start" | "end";
|
|
2345
2394
|
export type OverflowPosition = `unsafe ${ContentPosition}` | `safe ${ContentPosition}`;
|
|
2346
2395
|
/**
|
|
2347
|
-
*
|
|
2348
|
-
*
|
|
2349
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items
|
|
2396
|
+
* Controls the default inline-axis alignment for all items within a container. Learn more about [`justify-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).
|
|
2350
2397
|
*/
|
|
2351
2398
|
export type JustifyItemsKeyword = "normal" | "stretch" | BaselinePosition | OverflowPosition | ContentPosition;
|
|
2352
2399
|
/**
|
|
2353
|
-
*
|
|
2354
|
-
*
|
|
2355
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
|
|
2400
|
+
* Controls how all direct children are aligned along the cross axis. Learn more about [`align-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).
|
|
2356
2401
|
*/
|
|
2357
2402
|
export type AlignItemsKeyword = "normal" | "stretch" | BaselinePosition | OverflowPosition | ContentPosition;
|
|
2358
2403
|
/**
|
|
2359
|
-
*
|
|
2360
|
-
*
|
|
2361
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
|
|
2404
|
+
* Controls how space is distributed between and around content items along the main axis of a flex container or the inline axis of a grid container. Learn more about [`justify-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).
|
|
2362
2405
|
*/
|
|
2363
2406
|
export type JustifyContentKeyword = "normal" | ContentDistribution | OverflowPosition | ContentPosition;
|
|
2364
2407
|
/**
|
|
2365
|
-
*
|
|
2366
|
-
*
|
|
2367
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
|
|
2408
|
+
* Controls the distribution of space between and around content items along the cross axis of a flex container or the block axis of a grid container. Learn more about [`align-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).
|
|
2368
2409
|
*/
|
|
2369
2410
|
export type AlignContentKeyword = "normal" | BaselinePosition | ContentDistribution | OverflowPosition | ContentPosition;
|
|
2370
2411
|
interface GridProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps {
|
|
2371
2412
|
/**
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
|
|
2375
|
-
|
|
2376
|
-
*/
|
|
2413
|
+
* Defines the number and size of columns in the grid. Accepts any valid CSS [`grid-template-columns`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-columns) value, such as `"1fr 2fr"` or `"repeat(3, 1fr)"`.
|
|
2414
|
+
*
|
|
2415
|
+
* @default 'none'
|
|
2416
|
+
*/
|
|
2377
2417
|
gridTemplateColumns?: MaybeResponsive<string>;
|
|
2378
2418
|
/**
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
|
|
2382
|
-
|
|
2383
|
-
*/
|
|
2419
|
+
* Defines the number and size of rows in the grid. Accepts any valid CSS [`grid-template-rows`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-template-rows) value, such as `"auto 1fr"` or `"repeat(2, 100px)"`.
|
|
2420
|
+
*
|
|
2421
|
+
* @default 'none'
|
|
2422
|
+
*/
|
|
2384
2423
|
gridTemplateRows?: MaybeResponsive<string>;
|
|
2385
2424
|
/**
|
|
2386
|
-
|
|
2387
|
-
|
|
2388
|
-
|
|
2389
|
-
|
|
2390
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items
|
|
2391
|
-
@default '' - meaning no override
|
|
2392
|
-
*/
|
|
2425
|
+
* Aligns grid items along the inline (row) axis. Overrides the inline value of `placeItems`. Learn more about [`justify-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-items).
|
|
2426
|
+
*
|
|
2427
|
+
* @default '' - meaning no override
|
|
2428
|
+
*/
|
|
2393
2429
|
justifyItems?: MaybeResponsive<JustifyItemsKeyword | "">;
|
|
2394
2430
|
/**
|
|
2395
|
-
|
|
2396
|
-
|
|
2397
|
-
|
|
2398
|
-
|
|
2399
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
|
|
2400
|
-
@default '' - meaning no override
|
|
2401
|
-
*/
|
|
2431
|
+
* Aligns grid items along the block (column) axis. Overrides the block value of `placeItems`. Learn more about [`align-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).
|
|
2432
|
+
*
|
|
2433
|
+
* @default '' - meaning no override
|
|
2434
|
+
*/
|
|
2402
2435
|
alignItems?: MaybeResponsive<AlignItemsKeyword | "">;
|
|
2403
2436
|
/**
|
|
2404
|
-
|
|
2405
|
-
|
|
2406
|
-
|
|
2407
|
-
|
|
2408
|
-
*/
|
|
2437
|
+
* A shorthand for `justifyItems` and `alignItems` that sets both alignment axes at once. Learn more about [`place-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/place-items).
|
|
2438
|
+
*
|
|
2439
|
+
* @default 'normal normal'
|
|
2440
|
+
*/
|
|
2409
2441
|
placeItems?: MaybeResponsive<`${AlignItemsKeyword} ${JustifyItemsKeyword}` | AlignItemsKeyword>;
|
|
2410
2442
|
/**
|
|
2411
|
-
|
|
2412
|
-
|
|
2413
|
-
|
|
2414
|
-
|
|
2415
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
|
|
2416
|
-
@default '' - meaning no override
|
|
2417
|
-
*/
|
|
2443
|
+
* Controls how the grid's columns are distributed along the inline (row) axis when there is extra space. Overrides the inline value of `placeContent`. Learn more about [`justify-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).
|
|
2444
|
+
*
|
|
2445
|
+
* @default '' - meaning no override
|
|
2446
|
+
*/
|
|
2418
2447
|
justifyContent?: MaybeResponsive<JustifyContentKeyword | "">;
|
|
2419
2448
|
/**
|
|
2420
|
-
|
|
2421
|
-
|
|
2422
|
-
|
|
2423
|
-
|
|
2424
|
-
@see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
|
|
2425
|
-
@default '' - meaning no override
|
|
2426
|
-
*/
|
|
2449
|
+
* Controls how the grid's rows are distributed along the block (column) axis when there is extra space. Overrides the block value of `placeContent`. Learn more about [`align-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).
|
|
2450
|
+
*
|
|
2451
|
+
* @default '' - meaning no override
|
|
2452
|
+
*/
|
|
2427
2453
|
alignContent?: MaybeResponsive<AlignContentKeyword | "">;
|
|
2428
2454
|
/**
|
|
2429
|
-
|
|
2430
|
-
|
|
2431
|
-
|
|
2432
|
-
|
|
2433
|
-
*/
|
|
2455
|
+
* A shorthand for `justifyContent` and `alignContent` that sets both distribution axes at once. Learn more about [`place-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/place-content).
|
|
2456
|
+
*
|
|
2457
|
+
* @default 'normal normal'
|
|
2458
|
+
*/
|
|
2434
2459
|
placeContent?: MaybeResponsive<`${AlignContentKeyword} ${JustifyContentKeyword}` | AlignContentKeyword>;
|
|
2435
2460
|
}
|
|
2436
2461
|
interface GridItemProps$1 extends GlobalProps, BaseBoxPropsWithRole {
|
|
2437
2462
|
/**
|
|
2438
|
-
*
|
|
2439
|
-
*
|
|
2440
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column
|
|
2463
|
+
* The number of columns this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of columns. Learn more about [`grid-column`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column).
|
|
2441
2464
|
*
|
|
2442
2465
|
* @default 'auto'
|
|
2443
2466
|
*/
|
|
2444
2467
|
gridColumn?: `span ${number}` | "auto";
|
|
2445
2468
|
/**
|
|
2446
|
-
*
|
|
2447
|
-
*
|
|
2448
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row
|
|
2469
|
+
* The number of rows this item spans within the grid. Set to `auto` to let the grid determine placement automatically, or use `span {number}` to span a specific number of rows. Learn more about [`grid-row`](https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row).
|
|
2449
2470
|
*
|
|
2450
2471
|
* @default 'auto'
|
|
2451
2472
|
*/
|
|
@@ -2453,29 +2474,47 @@ interface GridItemProps$1 extends GlobalProps, BaseBoxPropsWithRole {
|
|
|
2453
2474
|
}
|
|
2454
2475
|
export interface BaseTypographyProps {
|
|
2455
2476
|
/**
|
|
2456
|
-
*
|
|
2477
|
+
* The color emphasis level that controls visual intensity.
|
|
2478
|
+
*
|
|
2479
|
+
* - `subdued`: Deemphasized color for secondary text, supporting labels, and less critical interface elements.
|
|
2480
|
+
* - `base`: Primary color for body text, standard UI elements, and general content with good readability.
|
|
2481
|
+
* - `strong`: Emphasized color for headings, key labels, and interactive elements that need prominence.
|
|
2457
2482
|
*
|
|
2458
2483
|
* @default 'base'
|
|
2459
2484
|
*/
|
|
2460
2485
|
color?: ColorKeyword;
|
|
2461
2486
|
/**
|
|
2462
|
-
*
|
|
2487
|
+
* The semantic meaning and color treatment of the component.
|
|
2488
|
+
*
|
|
2489
|
+
* - `auto`: Automatically determined based on context.
|
|
2490
|
+
* - `neutral`: General information without specific intent.
|
|
2491
|
+
* - `info`: Informational content or helpful tips.
|
|
2492
|
+
* - `success`: Positive outcomes or successful states.
|
|
2493
|
+
* - `caution`: Advisory notices that need attention.
|
|
2494
|
+
* - `warning`: Important warnings about potential issues.
|
|
2495
|
+
* - `critical`: Urgent problems or destructive actions.
|
|
2496
|
+
* - `accent`: Highlighted or promotional content.
|
|
2497
|
+
* - `custom`: Custom styling controlled by your theme.
|
|
2463
2498
|
*
|
|
2464
2499
|
* @default 'auto'
|
|
2465
2500
|
*/
|
|
2466
2501
|
tone?: ToneKeyword;
|
|
2467
2502
|
/**
|
|
2468
|
-
*
|
|
2503
|
+
* The rendering style for numbers in the font.
|
|
2504
|
+
*
|
|
2505
|
+
* - `auto`: Inherits the setting from the parent element.
|
|
2506
|
+
* - `normal`: Uses the font's default numeric glyphs.
|
|
2507
|
+
* - `tabular-nums`: Uses fixed-width numeric glyphs, ensuring numbers align vertically in tables or lists.
|
|
2469
2508
|
*
|
|
2470
|
-
*
|
|
2509
|
+
* Learn more about the [font-variant-numeric property](https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-numeric).
|
|
2471
2510
|
*
|
|
2472
|
-
* @default 'auto'
|
|
2511
|
+
* @default 'auto'
|
|
2473
2512
|
*/
|
|
2474
2513
|
fontVariantNumeric?: "auto" | "normal" | "tabular-nums";
|
|
2475
2514
|
/**
|
|
2476
|
-
*
|
|
2477
|
-
*
|
|
2478
|
-
* [
|
|
2515
|
+
* The language of the text content. Use this when the text is in a different language than the rest of the page, allowing assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
2516
|
+
*
|
|
2517
|
+
* 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).
|
|
2479
2518
|
*
|
|
2480
2519
|
* It is recommended to combine it with the `dir` attribute to ensure the text is rendered correctly if the surrounding content’s direction is different.
|
|
2481
2520
|
*
|
|
@@ -2485,12 +2524,12 @@ export interface BaseTypographyProps {
|
|
|
2485
2524
|
/**
|
|
2486
2525
|
* Indicates the directionality of the element’s text.
|
|
2487
2526
|
*
|
|
2488
|
-
* - `ltr`: languages written from left to right (
|
|
2489
|
-
* - `rtl`: languages written from right to left (
|
|
2490
|
-
* - `auto`:
|
|
2491
|
-
* - `
|
|
2527
|
+
* - `ltr`: The languages written from left to right (such as English).
|
|
2528
|
+
* - `rtl`: The languages written from right to left (such as Arabic).
|
|
2529
|
+
* - `auto`: The user agent determines the direction based on the content.
|
|
2530
|
+
* - `""`: The direction is inherited from parent elements (equivalent to not setting the attribute).
|
|
2492
2531
|
*
|
|
2493
|
-
*
|
|
2532
|
+
* Learn more about the [dir attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir).
|
|
2494
2533
|
*
|
|
2495
2534
|
* @default ''
|
|
2496
2535
|
*/
|
|
@@ -2498,9 +2537,9 @@ export interface BaseTypographyProps {
|
|
|
2498
2537
|
}
|
|
2499
2538
|
export interface BlockTypographyProps {
|
|
2500
2539
|
/**
|
|
2501
|
-
*
|
|
2540
|
+
* The maximum number of lines to display before truncating the text content.
|
|
2502
2541
|
*
|
|
2503
|
-
*
|
|
2542
|
+
* Learn more about the [-webkit-line-clamp property](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp).
|
|
2504
2543
|
*
|
|
2505
2544
|
* @default Infinity - no truncation is applied
|
|
2506
2545
|
*/
|
|
@@ -2508,19 +2547,16 @@ export interface BlockTypographyProps {
|
|
|
2508
2547
|
}
|
|
2509
2548
|
interface HeadingProps$1 extends GlobalProps, AccessibilityVisibilityProps, BlockTypographyProps {
|
|
2510
2549
|
/**
|
|
2511
|
-
* The
|
|
2550
|
+
* The heading text displayed within the heading component, which provides a title or section header for content.
|
|
2512
2551
|
*/
|
|
2513
2552
|
children?: ComponentChildren;
|
|
2514
2553
|
/**
|
|
2515
|
-
*
|
|
2554
|
+
* The semantic meaning of the component’s content. When set,
|
|
2516
2555
|
* the role will be used by assistive technologies to help users
|
|
2517
2556
|
* navigate the page.
|
|
2518
2557
|
*
|
|
2519
|
-
* - `
|
|
2520
|
-
* - `
|
|
2521
|
-
* and will prevent the element’s implicit ARIA semantics from
|
|
2522
|
-
* being exposed to the accessibility tree.
|
|
2523
|
-
* - `none`: a synonym for the `presentation` role.
|
|
2558
|
+
* - `presentation`: Removes semantic meaning, making the element purely decorative and ignored by screen readers.
|
|
2559
|
+
* - `none`: Completely hides the element and its content from assistive technologies.
|
|
2524
2560
|
*
|
|
2525
2561
|
* @default 'heading'
|
|
2526
2562
|
*
|
|
@@ -2530,94 +2566,110 @@ interface HeadingProps$1 extends GlobalProps, AccessibilityVisibilityProps, Bloc
|
|
|
2530
2566
|
*/
|
|
2531
2567
|
accessibilityRole?: "heading" | ExtractStrict<AccessibilityRole, "presentation" | "none">;
|
|
2532
2568
|
}
|
|
2569
|
+
/**
|
|
2570
|
+
* The shared properties for the icon component. An icon displays a graphical symbol with configurable appearance, color, and semantic meaning.
|
|
2571
|
+
*/
|
|
2533
2572
|
interface IconProps$1 extends GlobalProps, Pick<InteractionProps, "interestFor"> {
|
|
2534
2573
|
/**
|
|
2535
|
-
*
|
|
2574
|
+
* The semantic meaning and color treatment of the icon.
|
|
2575
|
+
*
|
|
2576
|
+
* - `'info'`: Informational content or helpful tips.
|
|
2577
|
+
* - `'auto'`: Automatically determined based on context.
|
|
2578
|
+
* - `'neutral'`: General information without specific intent.
|
|
2579
|
+
* - `'success'`: Positive outcomes or successful states.
|
|
2580
|
+
* - `'warning'`: Important warnings about potential issues.
|
|
2581
|
+
* - `'critical'`: Urgent problems or destructive actions.
|
|
2582
|
+
* - `'custom'`: Inherits a custom color from its parent element's CSS.
|
|
2536
2583
|
*
|
|
2537
2584
|
* @default 'auto'
|
|
2538
2585
|
*/
|
|
2539
2586
|
tone?: ToneKeyword;
|
|
2540
2587
|
/**
|
|
2541
|
-
*
|
|
2588
|
+
* The color intensity of the icon. Use `'subdued'` for less intense, or `'base'` for standard coloring.
|
|
2542
2589
|
*
|
|
2543
2590
|
* @default 'base'
|
|
2544
2591
|
*/
|
|
2545
2592
|
color?: ColorKeyword;
|
|
2546
2593
|
/**
|
|
2547
|
-
*
|
|
2594
|
+
* The size of the icon.
|
|
2595
|
+
*
|
|
2596
|
+
* - `'base'`: Default size that works well for most use cases.
|
|
2597
|
+
* - `'small'`: Small icon for inline use within text or compact UI elements.
|
|
2598
|
+
* - `'small-200'`: Extra small icon for the most compact contexts.
|
|
2599
|
+
* - `'small-100'`: Small icon suitable for tight or dense layouts.
|
|
2600
|
+
* - `'large'`: Large icon for emphasis or prominent display.
|
|
2601
|
+
* - `'large-100'`: Extra large icon for maximum visual impact.
|
|
2548
2602
|
*
|
|
2549
2603
|
* @default 'base'
|
|
2550
2604
|
*/
|
|
2551
2605
|
size?: SizeKeyword;
|
|
2606
|
+
/**
|
|
2607
|
+
* The icon to display. Can be any icon name from the icon library or a custom string identifier.
|
|
2608
|
+
*/
|
|
2552
2609
|
type?: IconType | AnyString;
|
|
2553
2610
|
}
|
|
2611
|
+
/**
|
|
2612
|
+
* The shared base properties for image-based components. These properties are common to all components that display images, including the image and product thumbnail components. Properties include `alt` for accessibility text, `src` for the image URL, `sizes` for responsive sizing hints, and `srcSet` for multiple image sources.
|
|
2613
|
+
*/
|
|
2554
2614
|
export interface BaseImageProps {
|
|
2555
2615
|
/**
|
|
2556
|
-
*
|
|
2557
|
-
*
|
|
2558
|
-
*
|
|
2559
|
-
*
|
|
2560
|
-
*
|
|
2561
|
-
*
|
|
2562
|
-
*
|
|
2563
|
-
*
|
|
2564
|
-
*
|
|
2565
|
-
*
|
|
2566
|
-
*
|
|
2567
|
-
*
|
|
2568
|
-
*
|
|
2569
|
-
* @default
|
|
2570
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt
|
|
2616
|
+
* Alternative text that describes the image for accessibility.
|
|
2617
|
+
*
|
|
2618
|
+
* Provides a text description of the image for users with assistive technology
|
|
2619
|
+
* and serves as a fallback when the image fails to load. A well-written description
|
|
2620
|
+
* enables people with visual impairments to understand non-text content.
|
|
2621
|
+
*
|
|
2622
|
+
* When a screen reader encounters an image, it reads this description aloud.
|
|
2623
|
+
* When an image fails to load, this text displays on screen, helping all users
|
|
2624
|
+
* understand what content was intended.
|
|
2625
|
+
*
|
|
2626
|
+
* Learn more about [writing effective alt text](https://www.shopify.com/ca/blog/image-alt-text#4)
|
|
2627
|
+
* and the [alt attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#alt).
|
|
2628
|
+
*
|
|
2629
|
+
* @default ''
|
|
2571
2630
|
*/
|
|
2572
2631
|
alt?: string;
|
|
2573
2632
|
/**
|
|
2574
|
-
* A set of media conditions and their corresponding sizes.
|
|
2575
|
-
*
|
|
2576
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes
|
|
2633
|
+
* A set of media conditions and their corresponding sizes. Learn more about the [sizes attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#sizes).
|
|
2577
2634
|
*/
|
|
2578
2635
|
sizes?: string;
|
|
2579
2636
|
/**
|
|
2580
2637
|
* The image source (either a remote URL or a local file resource).
|
|
2581
2638
|
*
|
|
2582
|
-
* When the image is loading or no `src` is provided, a placeholder
|
|
2583
|
-
*
|
|
2584
|
-
* @implementation Surfaces may choose the style of the placeholder, but the space the image occupies should be
|
|
2585
|
-
* reserved, except in cases where the image area does not have a contextual inline or block size, which should be rare.
|
|
2586
|
-
*
|
|
2587
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src
|
|
2639
|
+
* When the image is loading or no `src` is provided, a placeholder is rendered.
|
|
2640
|
+
* Learn more about the [src attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#src).
|
|
2588
2641
|
*/
|
|
2589
2642
|
src?: string;
|
|
2590
2643
|
/**
|
|
2591
|
-
* A set of image sources and their width or pixel density descriptors.
|
|
2592
|
-
*
|
|
2593
|
-
* This overrides the `src` property.
|
|
2594
|
-
*
|
|
2595
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset
|
|
2644
|
+
* A set of image sources and their width or pixel density descriptors. Learn more about the [srcset attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#srcset). This overrides the `src` property.
|
|
2596
2645
|
*/
|
|
2597
2646
|
srcSet?: string;
|
|
2598
2647
|
}
|
|
2648
|
+
/**
|
|
2649
|
+
* The shared properties for the image component. An image displays pictures with configurable sizing, loading behavior, and borders.
|
|
2650
|
+
*/
|
|
2599
2651
|
interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps {
|
|
2600
2652
|
/**
|
|
2601
|
-
* Sets the semantic meaning of the
|
|
2653
|
+
* Sets the semantic meaning of the image content. When set,
|
|
2602
2654
|
* the role will be used by assistive technologies to help users
|
|
2603
2655
|
* navigate the page.
|
|
2604
2656
|
*
|
|
2605
|
-
*
|
|
2657
|
+
* - `'img'`: Identifies the element as an image that conveys meaningful information to users.
|
|
2658
|
+
* - `'none'`: Completely hides the element and its content from assistive technologies.
|
|
2659
|
+
* - `'presentation'`: Removes semantic meaning, making the image purely decorative and ignored by screen readers.
|
|
2606
2660
|
*
|
|
2607
|
-
* @
|
|
2608
|
-
* the host applies it for you; for example, an HTML host rendering
|
|
2609
|
-
* an `<img>` element should not apply the `img` role.
|
|
2661
|
+
* @default 'img'
|
|
2610
2662
|
*/
|
|
2611
2663
|
accessibilityRole?: "img" | ExtractStrict<AccessibilityRole, "presentation" | "none">;
|
|
2612
2664
|
/**
|
|
2613
|
-
* The
|
|
2665
|
+
* The inline width (horizontal size) of the image.
|
|
2614
2666
|
*
|
|
2615
|
-
* - `fill`:
|
|
2616
|
-
* - `auto`:
|
|
2667
|
+
* - `'fill'`: The image takes up 100% of the available inline space.
|
|
2668
|
+
* - `'auto'`: The image is displayed at its natural size.
|
|
2617
2669
|
*
|
|
2618
|
-
*
|
|
2670
|
+
* Learn more about the [width attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#width).
|
|
2619
2671
|
*
|
|
2620
|
-
* @
|
|
2672
|
+
* @default 'fill'
|
|
2621
2673
|
*/
|
|
2622
2674
|
inlineSize?: "fill" | "auto";
|
|
2623
2675
|
/**
|
|
@@ -2628,238 +2680,250 @@ interface ImageProps$1 extends GlobalProps, BaseImageProps, BorderProps {
|
|
|
2628
2680
|
* - `inlineSize="fill"`: the aspect ratio will be respected and the image will take the necessary space.
|
|
2629
2681
|
* - `inlineSize="auto"`: the image will not render until it has loaded and the aspect ratio will be ignored.
|
|
2630
2682
|
*
|
|
2631
|
-
*
|
|
2632
|
-
* If the value is set as `0.5`, the getter returns `0.5 / 1`.
|
|
2683
|
+
* Learn more about the [aspect-ratio property](https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio).
|
|
2633
2684
|
*
|
|
2634
2685
|
* @default '1/1'
|
|
2635
|
-
*
|
|
2636
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/aspect-ratio
|
|
2637
2686
|
*/
|
|
2638
2687
|
aspectRatio?: `${number}${optionalSpace}/${optionalSpace}${number}` | `${number}`;
|
|
2639
2688
|
/**
|
|
2640
|
-
*
|
|
2641
|
-
* The image is positioned in the center of the container.
|
|
2689
|
+
* How the image should be resized to fit its container. The image is positioned in the center of the container. Learn more about the [object-fit property](https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit).
|
|
2642
2690
|
*
|
|
2643
|
-
*
|
|
2691
|
+
* - `'contain'`: Fits the entire image within the container, preserving aspect ratio. May leave empty space.
|
|
2692
|
+
* - `'cover'`: Fills the container while preserving aspect ratio, cropping the image if needed.
|
|
2644
2693
|
*
|
|
2645
|
-
* @
|
|
2694
|
+
* @default 'contain'
|
|
2646
2695
|
*/
|
|
2647
2696
|
objectFit?: "contain" | "cover";
|
|
2648
2697
|
/**
|
|
2649
2698
|
* Determines the loading behavior of the image:
|
|
2650
|
-
* - `eager`: Immediately loads the image, irrespective of its position within the visible viewport.
|
|
2651
|
-
* - `lazy`: Delays loading the image until it approaches a specified distance from the viewport.
|
|
2699
|
+
* - `'eager'`: Immediately loads the image, irrespective of its position within the visible viewport.
|
|
2700
|
+
* - `'lazy'`: Delays loading the image until it approaches a specified distance from the viewport.
|
|
2701
|
+
*
|
|
2702
|
+
* Learn more about the [loading attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading).
|
|
2652
2703
|
*
|
|
2653
2704
|
* @default 'eager'
|
|
2654
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#loading
|
|
2655
2705
|
*/
|
|
2656
2706
|
loading?: "eager" | "lazy";
|
|
2657
2707
|
/**
|
|
2658
|
-
*
|
|
2659
|
-
*
|
|
2660
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
|
|
2708
|
+
* A callback fired when the image loads successfully. Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload).
|
|
2661
2709
|
*/
|
|
2662
2710
|
onLoad?: (event: Event) => void;
|
|
2663
2711
|
/**
|
|
2664
|
-
*
|
|
2665
|
-
*
|
|
2666
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
|
|
2712
|
+
* A callback fired when the image fails to load. Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror).
|
|
2667
2713
|
*/
|
|
2668
2714
|
onError?: (event: Event) => void;
|
|
2669
2715
|
}
|
|
2670
2716
|
interface LinkProps$1 extends GlobalProps, LinkBehaviorProps {
|
|
2671
2717
|
/**
|
|
2672
|
-
* The
|
|
2718
|
+
* The text or elements displayed as the link's content.
|
|
2673
2719
|
*/
|
|
2674
2720
|
children?: ComponentChildren;
|
|
2675
2721
|
/**
|
|
2676
|
-
*
|
|
2722
|
+
* The semantic meaning and color treatment of the link.
|
|
2723
|
+
*
|
|
2724
|
+
* - `'auto'`: Automatically determined based on context.
|
|
2725
|
+
* - `'neutral'`: Removes the default link color, inheriting the surrounding text style.
|
|
2677
2726
|
*
|
|
2678
2727
|
* @default 'auto'
|
|
2679
2728
|
*/
|
|
2680
2729
|
tone?: ToneKeyword;
|
|
2681
2730
|
/**
|
|
2682
|
-
* A label that describes the purpose or
|
|
2683
|
-
*
|
|
2684
|
-
* Use this when using only an icon or the content of the link is not enough context
|
|
2685
|
-
* for users using assistive technologies.
|
|
2731
|
+
* A label that describes the purpose or content of the link for users of assistive technologies such as screen readers.
|
|
2686
2732
|
*/
|
|
2687
2733
|
accessibilityLabel?: string;
|
|
2688
2734
|
/**
|
|
2689
|
-
*
|
|
2690
|
-
* It will allow assistive technologies such as screen readers to invoke the correct pronunciation.
|
|
2691
|
-
* [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) ("subtag" label)
|
|
2735
|
+
* The language of the link's text content. Use this when the link text is in a different language than the rest of the page.
|
|
2692
2736
|
*/
|
|
2693
2737
|
lang?: string;
|
|
2694
2738
|
}
|
|
2695
2739
|
interface ListItemProps$1 extends GlobalProps {
|
|
2696
2740
|
/**
|
|
2697
|
-
* The content
|
|
2741
|
+
* The content displayed within the list item, which represents a single entry in an ordered or unordered list.
|
|
2698
2742
|
*/
|
|
2699
2743
|
children?: ComponentChildren;
|
|
2700
2744
|
}
|
|
2701
2745
|
interface MapProps$1 extends GlobalProps, SizingProps {
|
|
2702
2746
|
/**
|
|
2703
|
-
* A valid API key for the map service provider.
|
|
2704
|
-
*
|
|
2705
|
-
* The map service provider may require an API key. Without an API key the map could be hidden or render in a limited developer mode.
|
|
2747
|
+
* A valid API key for the map service provider. This key is required to load and render the map tiles. Obtain a key from a supported provider such as [Google Maps Platform](https://developers.google.com/maps/documentation/javascript/get-api-key).
|
|
2706
2748
|
*/
|
|
2707
2749
|
apiKey?: string;
|
|
2708
2750
|
/**
|
|
2709
|
-
*
|
|
2751
|
+
* The latitude of the map's center point, in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).
|
|
2710
2752
|
*
|
|
2711
2753
|
* @default 0
|
|
2712
2754
|
*/
|
|
2713
2755
|
latitude?: number;
|
|
2714
2756
|
/**
|
|
2715
|
-
*
|
|
2757
|
+
* The longitude of the map's center point, in degrees. Valid values range from -180 (west) to 180 (east).
|
|
2716
2758
|
*
|
|
2717
2759
|
* @default 0
|
|
2718
2760
|
*/
|
|
2719
2761
|
longitude?: number;
|
|
2720
2762
|
/**
|
|
2721
|
-
* A label that describes the purpose or contents of the map.
|
|
2722
|
-
*
|
|
2723
|
-
* When set, it will be announced to users using assistive technologies and will provide them with more context.
|
|
2763
|
+
* A label that describes the purpose or contents of the map for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about what the map displays.
|
|
2724
2764
|
*/
|
|
2725
2765
|
accessibilityLabel?: string;
|
|
2726
2766
|
/**
|
|
2727
|
-
* The initial
|
|
2728
|
-
*
|
|
2729
|
-
* Valid zoom values are numbers from zero up to 18.
|
|
2730
|
-
* Larger zoom values correspond to a higher resolution.
|
|
2767
|
+
* The initial zoom level of the map. Valid values are numbers from 0 (fully zoomed out, world view) to 18 (fully zoomed in, street level).
|
|
2731
2768
|
*
|
|
2732
2769
|
* @default 4
|
|
2733
2770
|
*/
|
|
2734
2771
|
zoom?: number;
|
|
2735
2772
|
/**
|
|
2736
|
-
* The maximum zoom level
|
|
2737
|
-
*
|
|
2738
|
-
* Valid zoom values are numbers from zero up to 18.
|
|
2773
|
+
* The maximum zoom level the user can reach on the map. Valid values are numbers from 0 (world view) to 18 (street level). Use this to prevent users from zooming in beyond a useful level of detail.
|
|
2739
2774
|
*
|
|
2740
2775
|
* @default 18
|
|
2741
2776
|
*/
|
|
2742
2777
|
maxZoom?: number;
|
|
2743
2778
|
/**
|
|
2744
|
-
* The minimum zoom level
|
|
2745
|
-
*
|
|
2746
|
-
* Valid zoom values are numbers from zero up to 18.
|
|
2779
|
+
* The minimum zoom level the user can reach on the map. Valid values are numbers from 0 (world view) to 18 (street level). Use this to prevent users from zooming out beyond a useful level of context.
|
|
2747
2780
|
*
|
|
2748
2781
|
* @default 0
|
|
2749
2782
|
*/
|
|
2750
2783
|
minZoom?: number;
|
|
2751
2784
|
/**
|
|
2752
|
-
*
|
|
2785
|
+
* A callback fired when the visible map boundaries change, such as after a pan or zoom completes.
|
|
2753
2786
|
*/
|
|
2754
2787
|
onBoundsChange?: (event: MapBoundsChangeEvent) => void;
|
|
2755
2788
|
/**
|
|
2756
|
-
*
|
|
2789
|
+
* A callback fired when the map view changes, such as when the user pans or zooms. Provides the new center location and zoom level.
|
|
2757
2790
|
*/
|
|
2758
2791
|
onViewChange?: (event: MapViewChangeEvent) => void;
|
|
2759
2792
|
/**
|
|
2760
|
-
*
|
|
2793
|
+
* A callback fired when the user clicks on the map. Provides the geographic location of the click.
|
|
2761
2794
|
*/
|
|
2762
2795
|
onClick?: (event: MapClickEvent) => void;
|
|
2763
2796
|
/**
|
|
2764
|
-
*
|
|
2797
|
+
* A callback fired when the user double-clicks on the map. Provides the geographic location of the double-click.
|
|
2765
2798
|
*/
|
|
2766
2799
|
onDblClick?: (event: MapDblClickEvent) => void;
|
|
2767
2800
|
}
|
|
2801
|
+
/**
|
|
2802
|
+
* A geographic coordinate pair representing a location on the map, defined by latitude and longitude values.
|
|
2803
|
+
*/
|
|
2768
2804
|
interface Location$1 {
|
|
2805
|
+
/**
|
|
2806
|
+
* The latitude of the location in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).
|
|
2807
|
+
*/
|
|
2769
2808
|
latitude?: number;
|
|
2809
|
+
/**
|
|
2810
|
+
* The longitude of the location in degrees. Valid values range from -180 (west) to 180 (east).
|
|
2811
|
+
*/
|
|
2770
2812
|
longitude?: number;
|
|
2771
2813
|
}
|
|
2814
|
+
/**
|
|
2815
|
+
* The geographic boundaries of a visible map area, defined by its north-east and south-west corners. Used by `MapBoundsChangeEvent` to report the currently visible map region.
|
|
2816
|
+
*/
|
|
2772
2817
|
export interface Bounds {
|
|
2818
|
+
/**
|
|
2819
|
+
* The north-east corner of the bounded area, representing the top-right of the visible map region.
|
|
2820
|
+
*/
|
|
2773
2821
|
northEast?: Location$1;
|
|
2822
|
+
/**
|
|
2823
|
+
* The south-west corner of the bounded area, representing the bottom-left of the visible map region.
|
|
2824
|
+
*/
|
|
2774
2825
|
southWest?: Location$1;
|
|
2775
2826
|
}
|
|
2827
|
+
/**
|
|
2828
|
+
* The event data provided when the map view changes, such as after the user pans or zooms. Contains the new center location and zoom level.
|
|
2829
|
+
*/
|
|
2776
2830
|
export interface MapViewChangeEvent extends Event {
|
|
2831
|
+
/**
|
|
2832
|
+
* The geographic location of the new map center after the view change.
|
|
2833
|
+
*/
|
|
2777
2834
|
location?: Location$1;
|
|
2835
|
+
/**
|
|
2836
|
+
* The current zoom level of the map after the view change, as a number from 0 (world view) to 18 (street level).
|
|
2837
|
+
*/
|
|
2778
2838
|
zoom?: number;
|
|
2779
2839
|
}
|
|
2840
|
+
/**
|
|
2841
|
+
* The event data provided when the visible map boundaries change, such as after a pan or zoom completes. Contains the new geographic bounds of the visible area.
|
|
2842
|
+
*/
|
|
2780
2843
|
export interface MapBoundsChangeEvent extends Event {
|
|
2844
|
+
/**
|
|
2845
|
+
* The geographic boundaries of the currently visible map area, defined by its north-east and south-west corners.
|
|
2846
|
+
*/
|
|
2781
2847
|
bounds?: Bounds;
|
|
2782
2848
|
}
|
|
2849
|
+
/**
|
|
2850
|
+
* The event data provided when the user clicks on the map. Contains the geographic location of the click.
|
|
2851
|
+
*/
|
|
2783
2852
|
export interface MapClickEvent extends Event {
|
|
2853
|
+
/**
|
|
2854
|
+
* The geographic location on the map where the click occurred, as a latitude/longitude coordinate pair.
|
|
2855
|
+
*/
|
|
2784
2856
|
location?: Location$1;
|
|
2785
2857
|
}
|
|
2858
|
+
/**
|
|
2859
|
+
* The event data provided when the user double-clicks on the map. Contains the geographic location of the double-click.
|
|
2860
|
+
*/
|
|
2786
2861
|
export interface MapDblClickEvent extends Event {
|
|
2862
|
+
/**
|
|
2863
|
+
* The geographic location on the map where the double-click occurred, as a latitude/longitude coordinate pair.
|
|
2864
|
+
*/
|
|
2787
2865
|
location?: Location$1;
|
|
2788
2866
|
}
|
|
2789
2867
|
interface MapMarkerProps$1 extends GlobalProps, InteractionProps, Pick<SizingProps, "blockSize" | "inlineSize"> {
|
|
2790
2868
|
/**
|
|
2791
|
-
*
|
|
2869
|
+
* The latitude of the marker’s position in degrees. Valid values range from -90 (South Pole) to 90 (North Pole).
|
|
2792
2870
|
*
|
|
2793
2871
|
* @default 0
|
|
2794
2872
|
*/
|
|
2795
2873
|
latitude?: number;
|
|
2796
2874
|
/**
|
|
2797
|
-
*
|
|
2875
|
+
* The longitude of the marker’s position in degrees. Valid values range from -180 (west) to 180 (east).
|
|
2798
2876
|
*
|
|
2799
2877
|
* @default 0
|
|
2800
2878
|
*/
|
|
2801
2879
|
longitude?: number;
|
|
2802
2880
|
/**
|
|
2803
|
-
* A label that describes the purpose of the marker. When set,
|
|
2804
|
-
* it will be announced to users using assistive technologies and will
|
|
2805
|
-
* provide them with more context.
|
|
2881
|
+
* A label that describes the purpose or location of the marker for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about what the marker represents.
|
|
2806
2882
|
*/
|
|
2807
2883
|
accessibilityLabel?: string;
|
|
2808
2884
|
/**
|
|
2809
|
-
*
|
|
2885
|
+
* Whether the marker can be grouped into clusters when the map is zoomed out. Clustering helps reduce visual clutter when many markers are close together at low zoom levels.
|
|
2810
2886
|
*
|
|
2811
2887
|
* @default false
|
|
2812
2888
|
*/
|
|
2813
2889
|
clusterable?: boolean;
|
|
2814
2890
|
/**
|
|
2815
|
-
*
|
|
2816
|
-
*
|
|
2817
|
-
* If unset, it will default to the provider’s default marker.
|
|
2891
|
+
* A custom graphic element to use as the marker. If not provided, the map provider’s default marker pin is displayed.
|
|
2818
2892
|
*/
|
|
2819
2893
|
graphic?: ComponentChildren;
|
|
2820
2894
|
/**
|
|
2821
|
-
*
|
|
2822
|
-
*
|
|
2823
|
-
* It does not trigger a click event on the map itself.
|
|
2895
|
+
* A callback fired when the user clicks on the marker. This event does not propagate to the parent map — only the marker receives the click.
|
|
2824
2896
|
*/
|
|
2825
2897
|
onClick?: (event: Event) => void;
|
|
2826
2898
|
}
|
|
2827
2899
|
interface ModalProps$1 extends GlobalProps, BaseOverlayProps, BaseOverlayMethods, ActionSlots {
|
|
2828
2900
|
/**
|
|
2829
|
-
* A label that describes the purpose of the modal. When set,
|
|
2830
|
-
* it will be announced to users using assistive technologies and will
|
|
2831
|
-
* provide them with more context.
|
|
2832
|
-
*
|
|
2833
|
-
* This overrides the `heading` prop for screen readers.
|
|
2901
|
+
* A label that describes the purpose of the modal, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the modal.
|
|
2834
2902
|
*/
|
|
2835
2903
|
accessibilityLabel?: string;
|
|
2836
2904
|
/**
|
|
2837
|
-
* A title that describes the content of the
|
|
2838
|
-
*
|
|
2905
|
+
* A title that describes the content of the modal.
|
|
2839
2906
|
*/
|
|
2840
2907
|
heading?: string;
|
|
2841
2908
|
/**
|
|
2842
|
-
* Adjust the padding around the
|
|
2843
|
-
*
|
|
2844
|
-
* `base`: applies padding that is appropriate for the element.
|
|
2909
|
+
* Adjust the padding around the modal content.
|
|
2845
2910
|
*
|
|
2846
|
-
* `
|
|
2847
|
-
* to the edge of the
|
|
2848
|
-
* to bring back the desired padding for the rest of the content.
|
|
2911
|
+
* - `base`: Applies padding that is appropriate for the element.
|
|
2912
|
+
* - `none`: Removes all padding from the element. This can be useful when elements inside the modal need to span to the edge of the modal. For example, a full-width image. In this case, rely on box with a padding of `base` to bring back the desired padding for the rest of the content.
|
|
2849
2913
|
*
|
|
2850
2914
|
* @default 'base'
|
|
2851
2915
|
*/
|
|
2852
2916
|
padding?: "base" | "none";
|
|
2853
2917
|
/**
|
|
2854
|
-
* Adjust the size of the
|
|
2918
|
+
* Adjust the size of the modal.
|
|
2855
2919
|
*
|
|
2856
|
-
* `max`:
|
|
2920
|
+
* `max`: Expands the modal to its maximum size as defined by the host application, on both the horizontal and vertical axes.
|
|
2857
2921
|
*
|
|
2858
2922
|
* @default 'base'
|
|
2859
2923
|
*/
|
|
2860
2924
|
size?: SizeKeyword | "max";
|
|
2861
2925
|
/**
|
|
2862
|
-
* The content of the
|
|
2926
|
+
* The content of the modal.
|
|
2863
2927
|
*/
|
|
2864
2928
|
children?: ComponentChildren;
|
|
2865
2929
|
}
|
|
@@ -2868,9 +2932,13 @@ interface MoneyFieldProps$1 extends GlobalProps, BaseTextFieldProps, NumberConst
|
|
|
2868
2932
|
export type MoneyAutocompleteField = ExtractStrict<AnyAutocompleteField, "transaction-amount">;
|
|
2869
2933
|
interface NumberFieldProps$1 extends GlobalProps, BaseTextFieldProps, AutocompleteProps<NumberAutocompleteField>, NumberConstraintsProps, FieldDecorationProps {
|
|
2870
2934
|
/**
|
|
2871
|
-
* Sets the virtual keyboard.
|
|
2935
|
+
* Sets the virtual keyboard layout for the field.
|
|
2936
|
+
*
|
|
2937
|
+
* - `'decimal'`: A numeric keyboard with a decimal point, suitable for decimal numbers.
|
|
2938
|
+
* - `'numeric'`: A numeric keyboard without a decimal point, suitable for integers.
|
|
2939
|
+
*
|
|
2940
|
+
* Learn more about the [inputMode attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode).
|
|
2872
2941
|
*
|
|
2873
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode
|
|
2874
2942
|
* @default 'decimal'
|
|
2875
2943
|
*/
|
|
2876
2944
|
inputMode?: "decimal" | "numeric";
|
|
@@ -2886,11 +2954,11 @@ interface OrderedListProps$1 extends GlobalProps {
|
|
|
2886
2954
|
}
|
|
2887
2955
|
interface ParagraphProps$1 extends GlobalProps, BaseTypographyProps, BlockTypographyProps, AccessibilityVisibilityProps {
|
|
2888
2956
|
/**
|
|
2889
|
-
* The content
|
|
2957
|
+
* The paragraph text content displayed within the paragraph component, which presents a block of related text with appropriate styling.
|
|
2890
2958
|
*/
|
|
2891
2959
|
children?: ComponentChildren;
|
|
2892
2960
|
/**
|
|
2893
|
-
*
|
|
2961
|
+
* The semantic type and styling treatment for the paragraph content.
|
|
2894
2962
|
*
|
|
2895
2963
|
* Other presentation properties on `s-paragraph` override the default styling.
|
|
2896
2964
|
*
|
|
@@ -2900,45 +2968,46 @@ interface ParagraphProps$1 extends GlobalProps, BaseTypographyProps, BlockTypogr
|
|
|
2900
2968
|
}
|
|
2901
2969
|
export type ParagraphType =
|
|
2902
2970
|
/**
|
|
2903
|
-
*
|
|
2971
|
+
* A semantic type that indicates the text is a structural grouping of related content.
|
|
2904
2972
|
*
|
|
2905
|
-
* In an HTML host, the text will be rendered in an `<p>` element.
|
|
2906
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p
|
|
2973
|
+
* In an HTML host, the text will be rendered in an `<p>` element. Learn more about the [p element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/p).
|
|
2907
2974
|
*/
|
|
2908
2975
|
"paragraph"
|
|
2909
2976
|
/**
|
|
2910
|
-
*
|
|
2977
|
+
* A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand.
|
|
2978
|
+
*
|
|
2911
2979
|
* It can be used for secondary content but also for disclaimers, terms and conditions, or legal information.
|
|
2912
2980
|
*
|
|
2913
2981
|
* Surfaces should apply a smaller font size than the default size.
|
|
2914
2982
|
*
|
|
2915
|
-
* In an HTML host, the text will be rendered in a `<small>` element.
|
|
2916
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small
|
|
2983
|
+
* In an HTML host, the text will be rendered in a `<small>` element. Learn more about the [small element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small).
|
|
2917
2984
|
*/
|
|
2918
2985
|
| "small";
|
|
2919
2986
|
interface PasswordFieldProps$1 extends GlobalProps, BaseTextFieldProps, MinMaxLengthProps, AutocompleteProps<PasswordAutocompleteField> {
|
|
2920
2987
|
}
|
|
2921
2988
|
export type PasswordAutocompleteField = ExtractStrict<AnyAutocompleteField, "new-password" | "current-password">;
|
|
2989
|
+
/**
|
|
2990
|
+
* The shared properties for the payment icon component. A payment icon displays a recognizable icon for a payment method, such as Visa, Mastercard, or PayPal.
|
|
2991
|
+
*/
|
|
2922
2992
|
interface PaymentIconProps$1 extends GlobalProps {
|
|
2923
2993
|
/**
|
|
2924
|
-
* The
|
|
2994
|
+
* The payment method to display. Specify a payment method name from the available set (for example, `'visa'`, `'mastercard'`, or `'paypal'`), or use an empty string to show no icon.
|
|
2925
2995
|
*
|
|
2926
2996
|
* @default ''
|
|
2927
2997
|
*/
|
|
2928
2998
|
type?: PaymentIconName | AnyString;
|
|
2929
2999
|
/**
|
|
2930
|
-
* A label that describes the
|
|
2931
|
-
*
|
|
2932
|
-
* When set, it will be announced to users using assistive technologies and will provide them with more context.
|
|
2933
|
-
* This should only be used if the icon requires an alternative internationalised label
|
|
2934
|
-
* or if it is otherwise inappropriate to make use of the default label included with the icon.
|
|
3000
|
+
* A label that describes the payment icon for accessibility. When set, it will be announced to users using assistive technologies such as screen readers, providing context about which payment method the icon represents.
|
|
2935
3001
|
*/
|
|
2936
3002
|
accessibilityLabel?: string;
|
|
2937
3003
|
}
|
|
3004
|
+
/**
|
|
3005
|
+
* The recognized payment method identifiers used by the `PaymentIcon` component. Each value maps to a branded icon for a specific payment provider, card network, digital wallet, or buy-now-pay-later service. Pass one of these names as the `type` property of `PaymentIcon` to display the corresponding icon — for example, `"visa"`, `"apple-pay"`, or `"afterpay"`.
|
|
3006
|
+
*/
|
|
2938
3007
|
export type PaymentIconName = "abn" | "acima-leasing" | "acuotaz" | "ada" | "addi" | "adyen" | "aeropay" | "affin-bank" | "affirm" | "aftee" | "afterpay-paynl-version" | "afterpay" | "airtel-money" | "airteltigo-mobile-money" | "aktia" | "akulaku-paylater" | "akulaku" | "alandsbanken" | "alfamart" | "alfamidi" | "alipay-hk" | "alipay-paynl-version" | "alipay" | "alliance-bank" | "alma" | "aman" | "amazon" | "ambank" | "american-express" | "amex" | "ansa-stored-value" | "ansa" | "anyday" | "apecoin" | "aplazo" | "apple-pay" | "aqsat" | "arbitrum" | "arhaus" | "arvato" | "ashley-plcc" | "ask" | "astrapay" | "atm-bersama" | "atobaraidotcom" | "atome" | "atone" | "atrato" | "au-kantan-kessai" | "au-pay" | "authorize-net" | "avalanche" | "axs" | "bancnet" | "banco-azteca" | "bancomat" | "bancontact" | "bangkok-bank" | "bank-islam" | "bank-muamalat" | "bank-rakyat" | "barclays" | "base" | "bbva-cie" | "bc-card" | "bca-klikpay" | "bca" | "bdo" | "belfius" | "benefit" | "best-buy-card" | "biercheque-paynl-version" | "bigc" | "billease" | "biller-paynl-version" | "billie" | "billink-method" | "billink" | "bitcoin-cash" | "bitcoin" | "bizum" | "blik" | "bnbchain" | "bni" | "bnp" | "bogus-app-coin" | "bogus" | "boleto" | "boodil" | "boost" | "bpi" | "braintree" | "bread-pay" | "bread" | "bri-direct-debit" | "bri" | "brimo" | "bsi" | "bsn" | "bss" | "busd" | "careem-pay" | "cartes-bancaires" | "cash-app-pay" | "cash" | "cashew" | "cashinvoice-latin-america" | "catch-payments" | "cebuana" | "cembrapay" | "centi" | "cetelem" | "checkout-finance" | "chinabank" | "cimb-clicks" | "cimb" | "circle-k" | "citadele" | "citi-pay" | "clave-telered" | "clearpay" | "clerq" | "cleverpay" | "clip" | "cliq" | "codensa" | "coinsph" | "collector-bank" | "coop" | "coppel-pay" | "credit-agricole" | "credit-key" | "creditclick-paynl-version" | "credix" | "cuotas" | "d-barai" | "dai" | "daily-yamazaki" | "dan-dan" | "dana" | "danamon-online" | "dankort" | "danske-bank" | "dappmx" | "dash" | "daviplata" | "de-cadeaukaart" | "depay" | "deutsche-bank" | "dinacard" | "diners-club" | "direct-bank-transfer-latin-america" | "directa24" | "directpay" | "discover" | "divido" | "dnb" | "docomo-barai" | "dogecoin" | "dropp" | "duitnow" | "duologi" | "dwolla" | "easywallet" | "ebucks" | "echelon-financing" | "ecpay" | "edenred" | "efecty" | "eft-secure" | "eftpos-au" | "eghl" | "elo" | "elv" | "empty" | "enets" | "eos" | "epayments" | "epospay" | "eps" | "erste" | "escrowcom" | "esr-paymentslip-switzerland" | "ethereum" | "etihad-guest-pay" | "etika" | "ewallet-indonesia" | "ewallet-philippines" | "ewallet-southkorea" | "facebook-pay" | "fairstone-payments" | "fam" | "familymart" | "fantom" | "farmlands" | "fashion-giftcard-paynlversion" | "fashioncheque" | "favepay" | "fawry" | "finloup" | "fintecture" | "fintoc" | "flexiti" | "float-payments" | "flying-blue-plus" | "forbrugsforeningen" | "forsa" | "fortiva" | "fps" | "fpx" | "freecharge" | "freedompay" | "futurepay-mytab" | "gcash" | "generalfinancing" | "generic" | "genoapay" | "gezondheidsbon-paynl-version" | "giftcard" | "giropay" | "givacard" | "glbe-paypal" | "glbe-plus" | "gmo-atokara" | "gmo-bank-transfer" | "gmo-postpay" | "gmo-virtualaccount" | "gnosis" | "google-pay" | "google-wallet" | "gopay" | "grabpay" | "grailpay" | "gusd" | "hana-card" | "handelsbanken" | "happy-pay" | "hello-clever" | "heylight" | "hitrustpay-transfer" | "home-credit" | "hong-leong-bank" | "hong-leong-connect" | "hsbc" | "huis-tuin-cadeau" | "humm" | "hyper" | "hypercard" | "hypercash" | "hyundai-card" | "ibexpay" | "ideal" | "in3-via-ideal" | "in3" | "inbank" | "indomaret" | "ing-homepay" | "interac" | "ivy" | "iwocapay-pay-later" | "jcb" | "jenius" | "jko" | "jousto" | "kakao-pay" | "kakebaraidotcom" | "kasikornbank" | "kasssh" | "katapult" | "kb-card" | "kbc-cbc" | "kcp-credit-card" | "kfast" | "khqr" | "klarna-pay-later" | "klarna-pay-now" | "klarna-slice-it" | "klarna" | "knaken-settle" | "knet" | "koalafi" | "koin" | "krediidipank" | "kredivo" | "krungsri" | "krungthai-bank" | "kueski-pay" | "kunst-en-cultuur-cadeaukaart" | "kuwait-finance-house" | "land-bank" | "laser" | "latitude-creditline-au" | "latitude-gem-au" | "latitude-gem-nz" | "latitude-go-au" | "latitudepay" | "lawson" | "laybuy-heart" | "laybuy" | "lbc" | "lhv" | "line-pay" | "linkaja" | "linkpay" | "litecoin" | "lku" | "lloyds" | "lotte-card" | "lpb" | "luminor" | "lunch-check" | "lydia" | "mach" | "mada" | "maestro" | "mandiri" | "mash" | "master" | "mastercard" | "masterpass" | "maxima" | "maya-bank" | "maya" | "maybank-qrpay" | "maybank" | "maybankm2u" | "mb-way" | "mb" | "mcash" | "medicinos-bankas" | "meeza" | "mercado-credito" | "mercado-pago" | "merpay" | "meta-pay" | "metro-bank" | "military-starcard" | "minicuotas" | "ministop" | "mobicred" | "mobikwik" | "mobilepay" | "mode" | "mokka" | "momopay" | "mondido" | "monero" | "monzo" | "mpesa" | "mtn-mobile-money" | "multisafepay" | "mybank" | "myfatoorah" | "n26" | "naps" | "nationale-bioscoopbon" | "nationale-entertainmentcard" | "natwest" | "naver-pay" | "nelo" | "nequi" | "netbanking" | "neteller" | "nh-card" | "nordea" | "notyd" | "novuna" | "npatobarai" | "npkakebarai" | "oca" | "ocbc-bank" | "octo-clicks" | "octopus" | "offline-bank-transfer-latin-america" | "ola-money" | "omannet" | "omasp" | "oney" | "online-banking" | "online-banktransfer" | "op" | "opay" | "openpay" | "optimism" | "orange-mobile-money" | "overstock-citicobrand" | "overstock-citiplcc" | "ovo" | "oxxo" | "ozow" | "pagoefectivo" | "paid" | "paidy" | "palawa" | "palawan" | "pastpay" | "pay-after-delivery-instalments" | "pay-by-bank-us" | "pay-by-bank" | "pay-easy" | "pay-pay" | "paybylink" | "paycash" | "payco" | "payconiq" | "payd" | "payfast-instant-eft" | "payflex" | "payid" | "payitmonthly" | "payjustnow" | "paymark-online-eftpos" | "paymaya" | "payme" | "paynow-mbank" | "paynow" | "payoo-qr" | "payoo" | "paypal" | "payplan" | "paypo" | "payrexx-bank-transfer" | "payright" | "paysafecard-paynl-version" | "paysafecard" | "paysafecash" | "paysera" | "paysquad" | "paytm" | "payto" | "paytomorrow" | "payu" | "payzapp" | "pei" | "perlasfinance" | "permata" | "pf-pay" | "pivo" | "pix" | "podium-cadeaukaart" | "pointspay" | "poli" | "polygon" | "poppankki" | "postfinance-card" | "postfinance-efinance" | "postpay" | "powered-by-ansa-stored-value" | "powered-by-ansa" | "powerpay" | "pps" | "prepaysolutions" | "progressive-leasing" | "przelew24" | "przelewy24-paynl-version" | "przelewy24" | "pse" | "public-bank" | "publicbank-pbe" | "qasitli" | "qliro" | "qr-promptpay" | "qris" | "qrph" | "rabbit-line-pay" | "rabobank" | "rakuten-pay" | "rapid-transfer" | "ratepay" | "raty-pekao" | "rcbc" | "rcs" | "reka" | "resolve-pay" | "revolut" | "rhb-bank" | "rhb-now" | "rietumu" | "riverty-paynl-version" | "riverty" | "rupay" | "saastopankki" | "sadad" | "sam" | "samsung-card" | "samsung-pay" | "santander" | "satisfi" | "satispay" | "sbpl" | "scalapay" | "scream-truck-wallet" | "scream-truck" | "seb" | "seicomart" | "sepa-bank-transfer" | "sepa-direct-debit" | "sequra" | "seven-eleven" | "sezzle" | "shib" | "shinhan-card" | "shop-pay" | "shopeepay" | "shopify-pay" | "siam-commercial" | "siauliu-bankas" | "siirto" | "sika-fsa" | "sika-hsa" | "sika" | "simpl" | "simple-pay" | "sinpe-movil" | "sistecredito" | "skeps" | "skrill-digital-wallet" | "slice-fnbo" | "smartpay" | "snap-checkout" | "snapmint" | "societe-generale" | "sofort" | "softbank" | "solana-pay-helio" | "solana-pay" | "solana" | "souhoola" | "spankki" | "sparkasse" | "spei" | "splitit" | "spotii" | "spraypay" | "standard-chartered" | "stc-pay" | "stoov" | "store-credit" | "stripe" | "sunkus" | "super-payments" | "svea-b2b-faktura" | "svea-b2b-invoice" | "svea-checkout" | "svea-credit-account" | "svea-delbetalning" | "svea-faktura" | "svea-invoice" | "svea-lasku" | "svea-ostukonto" | "svea-part-payment" | "svea-yrityslasku" | "sveaeramaksu" | "swedbank" | "swiftpay" | "swish" | "swissbilling" | "sympl" | "synchrony-pay" | "synchrony" | "tabby" | "tabit" | "taly" | "tamara" | "tandympayment" | "tasa-cero" | "tbi-bank" | "tcf" | "tendopay" | "tensile" | "tesco-lotus" | "thanachart-bank" | "timepayment" | "tiptop" | "todopay" | "toss" | "touch-n-go" | "tpay" | "trevipay" | "truelayer" | "truemoney-pay" | "trustly" | "twig-pay" | "twint" | "twoinvoice" | "uae-visa" | "uangme" | "ubp" | "underpay" | "unionpay" | "unipay" | "uob-ez-pay" | "uob-thai" | "uob" | "upi" | "urbo" | "urpay" | "usdc" | "usdp" | "v-pay" | "valu" | "venmo" | "ventipay" | "venus-plcc" | "viabill" | "vipps" | "visa-electron" | "visa" | "volksbank" | "volt" | "vvv-cadeaukaart-paynl-version" | "vvv-giftcard" | "waave-pay-by-bank" | "wallet" | "walley" | "wbtc" | "webshop-giftcard" | "wechat-pay" | "wechat-paynl-version" | "wegetfinancing" | "whish-checkout" | "whish-pay" | "wise" | "wissel" | "world-chain" | "xrp" | "yape" | "yappy" | "ymobile" | "younited-pay" | "zalopay" | "zapper" | "zingala" | "zinia" | "zip" | "zoodpay" | "zulily-credit-card" | "zustaina";
|
|
2939
3008
|
interface PopoverProps$1 extends GlobalProps, BaseOverlayProps, BaseOverlayMethods, ToggleEventProps, SizingProps {
|
|
2940
3009
|
/**
|
|
2941
|
-
* The content
|
|
3010
|
+
* The content displayed within the popover, which appears in an overlay positioned relative to its trigger element.
|
|
2942
3011
|
*/
|
|
2943
3012
|
children?: ComponentChildren;
|
|
2944
3013
|
}
|
|
@@ -2958,178 +3027,150 @@ interface PressButtonProps$1 extends GlobalProps, Pick<ButtonProps$1, "accessibi
|
|
|
2958
3027
|
*/
|
|
2959
3028
|
defaultPressed?: boolean;
|
|
2960
3029
|
}
|
|
3030
|
+
/**
|
|
3031
|
+
* The shared properties for the product thumbnail component. A product thumbnail displays a small preview image representing a product. Properties include `src` for the image URL, `alt` for accessibility text, `size` for controlling the thumbnail dimensions, and `totalItems` for displaying a quantity badge.
|
|
3032
|
+
*/
|
|
2961
3033
|
interface ProductThumbnailProps$1 extends GlobalProps, BaseImageProps {
|
|
2962
3034
|
/**
|
|
2963
|
-
*
|
|
3035
|
+
* The total number of items that the product thumbnail represents. When this value exceeds 1, the component displays a badge showing the count, useful for representing bundled products or quantities.
|
|
2964
3036
|
*/
|
|
2965
3037
|
totalItems?: number;
|
|
2966
3038
|
/**
|
|
2967
|
-
*
|
|
3039
|
+
* The size of the product thumbnail image.
|
|
3040
|
+
*
|
|
3041
|
+
* - `'base'`: Default size that works well in most contexts.
|
|
3042
|
+
* - `'small'`: Small thumbnail, good for secondary contexts or tight layouts.
|
|
3043
|
+
* - `'small-100'`: Extra small thumbnail for compact displays or dense lists.
|
|
2968
3044
|
*
|
|
2969
3045
|
* @default 'base'
|
|
2970
3046
|
*/
|
|
2971
3047
|
size?: SizeKeyword;
|
|
2972
3048
|
/**
|
|
2973
|
-
*
|
|
2974
|
-
*
|
|
2975
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload
|
|
3049
|
+
* A callback fired when the product thumbnail image loads successfully. Learn more about the [load event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onload).
|
|
2976
3050
|
*/
|
|
2977
3051
|
onLoad?: (event: Event) => void;
|
|
2978
3052
|
/**
|
|
2979
|
-
*
|
|
2980
|
-
*
|
|
2981
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror
|
|
3053
|
+
* A callback fired when the product thumbnail image fails to load. Learn more about the [error event](https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror).
|
|
2982
3054
|
*/
|
|
2983
3055
|
onError?: (event: Event) => void;
|
|
2984
3056
|
}
|
|
2985
3057
|
interface ProgressProps$1 extends GlobalProps {
|
|
2986
3058
|
/**
|
|
2987
|
-
* A label that describes
|
|
2988
|
-
* it will be announced to users using assistive technologies and will
|
|
2989
|
-
* provide them with more context.
|
|
2990
|
-
*
|
|
2991
|
-
* Use it to provide context of what is progressing.
|
|
3059
|
+
* A label announced by assistive technologies that describes what is progressing. Use this to provide context about the ongoing task, such as "Loading order details" or "Uploading file".
|
|
2992
3060
|
*/
|
|
2993
3061
|
accessibilityLabel?: string;
|
|
2994
3062
|
/**
|
|
2995
|
-
*
|
|
3063
|
+
* The semantic meaning and color treatment of the progress indicator.
|
|
2996
3064
|
*
|
|
2997
3065
|
* @default 'auto'
|
|
2998
3066
|
*/
|
|
2999
3067
|
tone?: ToneKeyword;
|
|
3000
3068
|
/**
|
|
3001
|
-
*
|
|
3002
|
-
*
|
|
3003
|
-
* It must be a valid floating point number between 0 and `max`, or between 0 and 1 if `max` is omitted.
|
|
3004
|
-
* If there is no value attribute, the progress bar is indeterminate;
|
|
3005
|
-
* this indicates that an activity is ongoing with no indication of how long it is expected to take.
|
|
3006
|
-
*
|
|
3007
|
-
* @implementation Surfaces should apply styling to cover that indeterminate state.
|
|
3008
|
-
* @implementation In a HTML host, you can customize the progress animation via the :indeterminate pseudo-class.
|
|
3069
|
+
* How much of the task has been completed. Must be a valid floating point number between `0` and `max`, or between `0` and `1` if `max` is omitted. When no value is set, the progress bar is indeterminate, indicating an ongoing activity with no estimated completion time.
|
|
3009
3070
|
*
|
|
3010
|
-
*
|
|
3011
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/:indeterminate#progress_bar
|
|
3071
|
+
* Learn more about the [value attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#value).
|
|
3012
3072
|
*/
|
|
3013
3073
|
value?: number;
|
|
3014
3074
|
/**
|
|
3015
|
-
*
|
|
3075
|
+
* The total amount of work the task requires. Must be a value greater than `0` and a valid floating point number.
|
|
3016
3076
|
*
|
|
3017
|
-
*
|
|
3077
|
+
* Learn more about the [max attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max).
|
|
3018
3078
|
*
|
|
3019
3079
|
* @default 1
|
|
3020
|
-
*
|
|
3021
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress#max
|
|
3022
3080
|
*/
|
|
3023
3081
|
max?: number;
|
|
3024
3082
|
}
|
|
3083
|
+
/**
|
|
3084
|
+
* The shared properties for the QR code component. A QR code generates and displays a scannable matrix barcode from a given string. Properties include `content` for the data to encode, `size` for display dimensions, `border` for visual framing, and `logo` for branding.
|
|
3085
|
+
*/
|
|
3025
3086
|
interface QRCodeProps$1 extends GlobalProps {
|
|
3026
3087
|
/**
|
|
3027
|
-
*
|
|
3088
|
+
* Whether to display a border around the QR code.
|
|
3028
3089
|
*
|
|
3029
|
-
* `base`:
|
|
3030
|
-
* `none`:
|
|
3090
|
+
* - `'base'`: Applies a standard border to frame the QR code.
|
|
3091
|
+
* - `'none'`: Removes the border for seamless integration with the surrounding layout.
|
|
3031
3092
|
*
|
|
3032
3093
|
* @default 'base'
|
|
3033
3094
|
*/
|
|
3034
3095
|
border?: "base" | "none";
|
|
3035
3096
|
/**
|
|
3036
|
-
* The content to be encoded in the QR code,
|
|
3037
|
-
* Specific string formatting can trigger actions on the user's device when scanned, like opening geolocation
|
|
3038
|
-
* coordinates on a map, opening a preferred app or app store entry, preparing an email, text message, and more.
|
|
3097
|
+
* The content to be encoded in the QR code, such as a URL, email address, or plain text. When scanned, the user's device will process this content — typically by opening a URL in a browser or prompting an action based on the content type.
|
|
3039
3098
|
*/
|
|
3040
3099
|
content?: string;
|
|
3041
3100
|
/**
|
|
3042
3101
|
* The displayed size of the QR code.
|
|
3043
3102
|
*
|
|
3044
|
-
* `
|
|
3045
|
-
* `
|
|
3103
|
+
* - `'base'`: The QR code is displayed at its default fixed size.
|
|
3104
|
+
* - `'fill'`: The QR code takes up 100% of the available inline size, useful for responsive layouts.
|
|
3046
3105
|
*
|
|
3047
3106
|
* @default 'base'
|
|
3048
3107
|
*/
|
|
3049
3108
|
size?: "base" | "fill";
|
|
3050
3109
|
/**
|
|
3051
|
-
* A label that describes the purpose or contents of the QR code. When set,
|
|
3052
|
-
* it will be announced to users using assistive technologies and will
|
|
3053
|
-
* provide more context about what the QR code may do when scanned.
|
|
3110
|
+
* A label that describes the purpose or contents of the QR code for accessibility. When set, it will be announced to users using assistive technologies such as screen readers.
|
|
3054
3111
|
*
|
|
3055
3112
|
* @default 'QR code' (translated to the user's locale)
|
|
3056
3113
|
*/
|
|
3057
3114
|
accessibilityLabel?: string;
|
|
3058
3115
|
/**
|
|
3059
|
-
*
|
|
3060
|
-
* If an error occurs, the QR code and its child elements will not be displayed.
|
|
3116
|
+
* A callback fired when the conversion of `content` to a QR code fails. This can happen when the content is too long or contains unsupported characters.
|
|
3061
3117
|
*/
|
|
3062
3118
|
onError?: (event: Event) => void;
|
|
3063
3119
|
/**
|
|
3064
|
-
* URL of an image to
|
|
3065
|
-
* This is useful for branding or to indicate to the user what scanning the QR code will do.
|
|
3066
|
-
* By default, no image is displayed.
|
|
3120
|
+
* The URL of an image to display in the center of the QR code, typically used for branding. The image should be small enough not to interfere with the QR code's scannability.
|
|
3067
3121
|
*/
|
|
3068
3122
|
logo?: string;
|
|
3069
3123
|
}
|
|
3070
3124
|
interface QueryContainerProps$1 extends GlobalProps {
|
|
3071
3125
|
/**
|
|
3072
|
-
* The
|
|
3126
|
+
* The child elements to render inside the query container.
|
|
3073
3127
|
*/
|
|
3074
3128
|
children?: ComponentChildren;
|
|
3075
3129
|
/**
|
|
3076
|
-
*
|
|
3077
|
-
*
|
|
3078
|
-
* We place the container name of `s-default` on every container. Because of this, it is not required to add a `containerName` identifier in your queries. For example, a `@container (inline-size <= 300px) none, auto` query is equivalent to `@container s-default (inline-size <= 300px) none, auto`.
|
|
3079
|
-
*
|
|
3080
|
-
* Any value set in `containerName` will be set alongside alongside `s-default`. For example, `containerName="my-container-name"` will result in a value of `s-default my-container-name` set on the `container-name` CSS property of the rendered HTML.
|
|
3130
|
+
* A custom name for the container, used in [container queries](https://developer.mozilla.org/en-US/docs/Web/CSS/container-name) to target this container specifically. The value is added alongside the default name `s-default`.
|
|
3081
3131
|
*
|
|
3082
3132
|
* @default ''
|
|
3083
|
-
*
|
|
3084
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/container-name
|
|
3085
|
-
*
|
|
3086
|
-
* @implementation You must always have a CSS `container-name` of `s-default` for this component.
|
|
3087
3133
|
*/
|
|
3088
3134
|
containerName?: string;
|
|
3089
3135
|
}
|
|
3136
|
+
/**
|
|
3137
|
+
* The overflow behavior for a scrollable container axis.
|
|
3138
|
+
*
|
|
3139
|
+
* - `auto`: Content that exceeds the container is clipped and becomes scrollable.
|
|
3140
|
+
* - `hidden`: Content that exceeds the container is clipped and not scrollable.
|
|
3141
|
+
*/
|
|
3090
3142
|
export type OverflowKeyword = "auto" | "hidden";
|
|
3091
3143
|
interface ScrollBoxProps$1 extends GlobalProps, Omit<BaseBoxPropsWithRole, "overflow"> {
|
|
3092
3144
|
/**
|
|
3093
|
-
*
|
|
3094
|
-
*
|
|
3095
|
-
* - `hidden`: clips the content when it is larger than the element’s container and the element will not be scrollable in that axis.
|
|
3096
|
-
* - `auto`: clips the content when it is larger than the element’s container and make it scrollable in that axis.
|
|
3145
|
+
* The overflow behavior of the scroll box, controlling whether content that exceeds the container is scrollable or clipped. Learn more about [`overflow`](https://developer.mozilla.org/en-US/docs/Web/CSS/overflow).
|
|
3097
3146
|
*
|
|
3098
|
-
*
|
|
3147
|
+
* - `hidden`: Content is clipped and the element is not scrollable in that axis.
|
|
3148
|
+
* - `auto`: Content is clipped and becomes scrollable in that axis.
|
|
3099
3149
|
*
|
|
3100
|
-
* -
|
|
3150
|
+
* Supports 1-to-2-value syntax using flow-relative axes. Two values are ordered as `block inline` (for example, `hidden auto` clips vertically and scrolls horizontally).
|
|
3101
3151
|
*
|
|
3102
3152
|
* @default 'auto'
|
|
3103
|
-
*
|
|
3104
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/overflow
|
|
3105
3153
|
*/
|
|
3106
3154
|
overflow?: OverflowKeyword | `${OverflowKeyword} ${OverflowKeyword}`;
|
|
3107
3155
|
}
|
|
3108
3156
|
interface SectionProps$1 extends GlobalProps, ActionSlots {
|
|
3109
3157
|
/**
|
|
3110
|
-
* The content
|
|
3158
|
+
* The child elements to render inside the section, typically the main content area below the heading.
|
|
3111
3159
|
*/
|
|
3112
3160
|
children?: ComponentChildren;
|
|
3113
3161
|
/**
|
|
3114
|
-
* A label
|
|
3115
|
-
*
|
|
3116
|
-
* When no `heading` property is provided or included as a children of the Section, you **must** provide an
|
|
3117
|
-
* `accessibilityLabel` to describe the Section. This is important as it allows assistive technologies to provide
|
|
3118
|
-
* the right context to users.
|
|
3162
|
+
* A label announced by assistive technologies that describes the purpose of the section. When no `heading` property is provided, you **must** set `accessibilityLabel` so screen readers can identify the section.
|
|
3119
3163
|
*/
|
|
3120
3164
|
accessibilityLabel?: string;
|
|
3121
3165
|
/**
|
|
3122
|
-
*
|
|
3166
|
+
* The heading text displayed at the top of the section to summarize its content.
|
|
3123
3167
|
*/
|
|
3124
3168
|
heading?: string;
|
|
3125
3169
|
/**
|
|
3126
|
-
*
|
|
3170
|
+
* The padding applied to all edges of the section.
|
|
3127
3171
|
*
|
|
3128
|
-
* - `base`:
|
|
3129
|
-
*
|
|
3130
|
-
* - `none`: removes all padding from the element. This can be useful when elements inside the Section need to span
|
|
3131
|
-
* to the edge of the Section. For example, a full-width image. In this case, rely on `s-box` with a padding of 'base'
|
|
3132
|
-
* to bring back the desired padding for the rest of the content.
|
|
3172
|
+
* - `base`: Applies context-appropriate padding. In some contexts this may result in no visible padding.
|
|
3173
|
+
* - `none`: Removes all padding, allowing child elements to span the full width of the section. Use a Box with `base` padding to restore spacing for individual content areas.
|
|
3133
3174
|
*
|
|
3134
3175
|
* @default 'base'
|
|
3135
3176
|
*/
|
|
@@ -3145,28 +3186,15 @@ interface SelectProps$1 extends GlobalProps, AutocompleteProps<AnyAutocompleteFi
|
|
|
3145
3186
|
}
|
|
3146
3187
|
interface SheetProps$1 extends BaseOverlayProps, BaseOverlayMethods, ToggleEventProps, GlobalProps, ActionSlots {
|
|
3147
3188
|
/**
|
|
3148
|
-
* A label that describes the purpose of the sheet. When set,
|
|
3149
|
-
* it will be announced to users using assistive technologies and will
|
|
3150
|
-
* provide them with more context.
|
|
3151
|
-
*
|
|
3152
|
-
* This overrides the `heading` prop for screen readers.
|
|
3189
|
+
* A label that describes the purpose of the sheet, announced by assistive technologies. When set, screen readers will use this label instead of the `heading` to describe the sheet.
|
|
3153
3190
|
*/
|
|
3154
3191
|
accessibilityLabel?: string;
|
|
3155
3192
|
/**
|
|
3156
|
-
* The content of the
|
|
3193
|
+
* The content of the sheet.
|
|
3157
3194
|
*/
|
|
3158
3195
|
children?: ComponentChildren;
|
|
3159
3196
|
/**
|
|
3160
|
-
*
|
|
3161
|
-
* This property is necessary in some cases, but its usage is generally discouraged due to potential negative impacts on user experience.
|
|
3162
|
-
*
|
|
3163
|
-
* Developers should:
|
|
3164
|
-
* - Only set this property to true when there are vitally important behaviors of the application that depend on the user interacting with the sheet.
|
|
3165
|
-
* - Make every effort to conditionally hide the sheet based on the state of checkout. An explicit example is custom privacy consent, where the sheet should only be displayed when consent is necessary and has not yet been explicitly given by the user.
|
|
3166
|
-
*
|
|
3167
|
-
* This property is useful for when the Sheet needs to be rendered on the page load and not triggered by a user action.
|
|
3168
|
-
* The property should only take effect when the `Sheet` is rendered for the first time.
|
|
3169
|
-
* To toggle the Sheet after it has been rendered, use the `ui.showOverlay()` method instead.
|
|
3197
|
+
* Whether the sheet should be open when it first renders. Use sparingly — only when the user must interact with the sheet before proceeding (for example, a privacy consent prompt). Only takes effect on the initial render.
|
|
3170
3198
|
*
|
|
3171
3199
|
* @default false
|
|
3172
3200
|
*/
|
|
@@ -3178,12 +3206,8 @@ interface SheetProps$1 extends BaseOverlayProps, BaseOverlayMethods, ToggleEvent
|
|
|
3178
3206
|
/**
|
|
3179
3207
|
* Adjust the padding of all edges.
|
|
3180
3208
|
*
|
|
3181
|
-
* `base`:
|
|
3182
|
-
*
|
|
3183
|
-
*
|
|
3184
|
-
* `none`: removes all padding from the element. This can be useful when elements inside the Sheet need to span
|
|
3185
|
-
* to the edge of the Sheet. For example, a full-width image. In this case, rely on `Box` with a padding of 'base'
|
|
3186
|
-
* to bring back the desired padding for the rest of the content.
|
|
3209
|
+
* - `base`: Applies padding that is appropriate for the element. This might result in no padding if Shopify determines that is the right design decision for a particular context.
|
|
3210
|
+
* - `none`: Removes all padding from the element. This can be useful when elements inside the sheet need to span to the edge of the sheet. For example, a full-width image. In this case, rely on box with a padding of `base` to bring back the desired padding for the rest of the content.
|
|
3187
3211
|
*
|
|
3188
3212
|
* @default 'base'
|
|
3189
3213
|
*/
|
|
@@ -3205,63 +3229,57 @@ interface SkeletonParagraphProps$1 extends GlobalProps {
|
|
|
3205
3229
|
}
|
|
3206
3230
|
interface SpinnerProps$1 extends GlobalProps {
|
|
3207
3231
|
/**
|
|
3208
|
-
*
|
|
3232
|
+
* The size of the spinner icon.
|
|
3209
3233
|
*
|
|
3210
3234
|
* @default 'base'
|
|
3211
3235
|
*/
|
|
3212
3236
|
size?: SizeKeyword;
|
|
3213
3237
|
/**
|
|
3214
|
-
* A label that describes the purpose of the
|
|
3215
|
-
* it will be announced to users using assistive technologies and will
|
|
3216
|
-
* provide them with more context. Providing an `accessibilityLabel` is
|
|
3217
|
-
* recommended if there is no accompanying text describing that something
|
|
3218
|
-
* is loading.
|
|
3238
|
+
* A label that describes the purpose of the spinner for assistive technologies like screen readers. Provide an `accessibilityLabel` when there is no visible text that conveys a loading state.
|
|
3219
3239
|
*/
|
|
3220
3240
|
accessibilityLabel?: string;
|
|
3221
3241
|
}
|
|
3222
3242
|
interface StackProps$1 extends GlobalProps, BaseBoxPropsWithRole, GapProps {
|
|
3223
3243
|
/**
|
|
3224
|
-
* The
|
|
3244
|
+
* The child elements to render inside the stack.
|
|
3225
3245
|
*/
|
|
3226
3246
|
children?: ComponentChildren;
|
|
3227
3247
|
/**
|
|
3228
|
-
*
|
|
3248
|
+
* The axis along which child elements are arranged, using [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values).
|
|
3229
3249
|
*
|
|
3230
|
-
*
|
|
3250
|
+
* - `block`: Children are stacked vertically (in horizontal writing modes). Content does not wrap.
|
|
3251
|
+
* - `inline`: Children are arranged horizontally (in horizontal writing modes). Content wraps when it overflows.
|
|
3231
3252
|
*
|
|
3232
|
-
* @
|
|
3253
|
+
* @default 'block'
|
|
3233
3254
|
*/
|
|
3234
3255
|
direction?: MaybeResponsive<"block" | "inline">;
|
|
3235
3256
|
/**
|
|
3236
|
-
*
|
|
3257
|
+
* Controls how child elements are distributed along the main axis. Learn more about [`justify-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content).
|
|
3237
3258
|
*
|
|
3238
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
|
|
3239
3259
|
* @default 'normal'
|
|
3240
3260
|
*/
|
|
3241
3261
|
justifyContent?: MaybeResponsive<JustifyContentKeyword>;
|
|
3242
3262
|
/**
|
|
3243
|
-
*
|
|
3263
|
+
* Controls how child elements are aligned along the cross axis. Learn more about [`align-items`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items).
|
|
3244
3264
|
*
|
|
3245
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
|
|
3246
3265
|
* @default 'normal'
|
|
3247
3266
|
*/
|
|
3248
3267
|
alignItems?: MaybeResponsive<AlignItemsKeyword>;
|
|
3249
3268
|
/**
|
|
3250
|
-
*
|
|
3269
|
+
* Controls how lines of content are distributed along the cross axis when there is extra space. Learn more about [`align-content`](https://developer.mozilla.org/en-US/docs/Web/CSS/align-content).
|
|
3251
3270
|
*
|
|
3252
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/CSS/align-content
|
|
3253
3271
|
* @default 'normal'
|
|
3254
3272
|
*/
|
|
3255
3273
|
alignContent?: MaybeResponsive<AlignContentKeyword>;
|
|
3256
3274
|
}
|
|
3257
3275
|
interface SummaryProps$1 extends GlobalProps {
|
|
3258
3276
|
/**
|
|
3259
|
-
* The content
|
|
3277
|
+
* The content displayed as the clickable label of the disclosure widget. This label is always visible and users interact with it to toggle the details content open or closed.
|
|
3260
3278
|
*
|
|
3261
|
-
* Interactive content is disallowed. For example, you can use
|
|
3279
|
+
* Interactive content is disallowed. For example, you can use an `s-text` element for extra formatting but
|
|
3262
3280
|
* elements like buttons and fields are not allowed.
|
|
3263
3281
|
*
|
|
3264
|
-
*
|
|
3282
|
+
* Learn more about the [summary element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/summary).
|
|
3265
3283
|
*
|
|
3266
3284
|
* @implementation Surfaces may apply styling to this element. An icon suggesting the state (open or closed) of the
|
|
3267
3285
|
* details element is recommended.
|
|
@@ -3274,13 +3292,13 @@ interface SwitchProps$1 extends GlobalProps, BaseCheckableProps, BasicFieldProps
|
|
|
3274
3292
|
}
|
|
3275
3293
|
interface TextProps$1 extends GlobalProps, AccessibilityVisibilityProps, BaseTypographyProps, DisplayProps, Pick<InteractionProps, "interestFor"> {
|
|
3276
3294
|
/**
|
|
3277
|
-
* The content
|
|
3295
|
+
* The text content displayed within the text component, which applies semantic meaning and styling appropriate to the specified text type.
|
|
3278
3296
|
*/
|
|
3279
3297
|
children?: ComponentChildren;
|
|
3280
3298
|
/**
|
|
3281
|
-
*
|
|
3299
|
+
* The semantic type and styling treatment for the text content.
|
|
3282
3300
|
*
|
|
3283
|
-
* Other presentation properties on
|
|
3301
|
+
* Other presentation properties on `s-text` override the default styling.
|
|
3284
3302
|
*
|
|
3285
3303
|
* @default 'generic'
|
|
3286
3304
|
*/
|
|
@@ -3288,7 +3306,7 @@ interface TextProps$1 extends GlobalProps, AccessibilityVisibilityProps, BaseTyp
|
|
|
3288
3306
|
}
|
|
3289
3307
|
export type TextType =
|
|
3290
3308
|
/**
|
|
3291
|
-
*
|
|
3309
|
+
* A semantic type that indicates the text is contact information. Typically used for addresses.
|
|
3292
3310
|
*
|
|
3293
3311
|
* This must have `inline` layout (despite the default being `block` in HTML hosts).
|
|
3294
3312
|
*
|
|
@@ -3298,65 +3316,60 @@ export type TextType =
|
|
|
3298
3316
|
*
|
|
3299
3317
|
* @implementation vertical alignment should be `baseline` (`vertical-align: baseline`)
|
|
3300
3318
|
*
|
|
3301
|
-
*
|
|
3319
|
+
* Learn more about the [address element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/address).
|
|
3302
3320
|
*/
|
|
3303
3321
|
"address"
|
|
3304
3322
|
/**
|
|
3305
|
-
*
|
|
3323
|
+
* A semantic type that indicates the text is no longer accurate or no longer relevant. One such use-case is discounted prices.
|
|
3306
3324
|
*
|
|
3307
3325
|
* Surfaces should apply styling to this type to suggest its content no longer applies.
|
|
3308
3326
|
*
|
|
3309
|
-
* In an HTML host, the text will be rendered in a `<s>` element.
|
|
3310
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s
|
|
3327
|
+
* In an HTML host, the text will be rendered in a `<s>` element. Learn more about the [s element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/s).
|
|
3311
3328
|
*/
|
|
3312
3329
|
| "redundant"
|
|
3313
3330
|
/**
|
|
3314
|
-
*
|
|
3331
|
+
* A semantic type that indicates the text is marked or highlighted and relevant to the user’s current action.
|
|
3315
3332
|
* One such use-case is to indicate the characters that matched a search query.
|
|
3316
3333
|
*
|
|
3317
3334
|
* Surfaces should apply styling to this type to draw attention to the content.
|
|
3318
3335
|
*
|
|
3319
|
-
* In an HTML host, the text will be rendered in a `<mark>` element.
|
|
3320
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark
|
|
3336
|
+
* In an HTML host, the text will be rendered in a `<mark>` element. Learn more about the [mark element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/mark).
|
|
3321
3337
|
*/
|
|
3322
3338
|
| "mark"
|
|
3323
3339
|
/**
|
|
3324
|
-
*
|
|
3340
|
+
* A semantic type that indicates emphatic stress. Typically for words that have a stressed emphasis compared to surrounding text.
|
|
3325
3341
|
*
|
|
3326
3342
|
* Surfaces should apply styling to this type to distinguish it from surrounding text. Italicization is a common choice, but not required.
|
|
3327
3343
|
*
|
|
3328
|
-
* In an HTML host, the text will be rendered in an `<em>` element.
|
|
3329
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em
|
|
3344
|
+
* In an HTML host, the text will be rendered in an `<em>` element. Learn more about the [em element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em).
|
|
3330
3345
|
*/
|
|
3331
3346
|
| "emphasis"
|
|
3332
3347
|
/**
|
|
3333
|
-
*
|
|
3334
|
-
*
|
|
3335
|
-
* instead of representing its semantic meaning.
|
|
3348
|
+
* A semantic type that indicates an offset from the normal prose of the text.
|
|
3349
|
+
*
|
|
3350
|
+
* Typically used to indicate a foreign word, fictional character thoughts, or when the text refers to the definition of a word instead of representing its semantic meaning.
|
|
3336
3351
|
*
|
|
3337
3352
|
* Surfaces should italicize this content by default.
|
|
3338
3353
|
*
|
|
3339
|
-
* In an HTML host, the text will be rendered in a `<i>` tag.
|
|
3340
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i
|
|
3354
|
+
* In an HTML host, the text will be rendered in a `<i>` tag. Learn more about the [i element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/i).
|
|
3341
3355
|
*/
|
|
3342
3356
|
| "offset"
|
|
3343
3357
|
/**
|
|
3344
|
-
*
|
|
3358
|
+
* A semantic type that indicates strong importance, seriousness, or urgency.
|
|
3345
3359
|
*
|
|
3346
3360
|
* Surfaces should render this content bold by default.
|
|
3347
3361
|
*
|
|
3348
|
-
* In an HTML host, the text will be rendered in a `<strong>` tag.
|
|
3349
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong
|
|
3362
|
+
* In an HTML host, the text will be rendered in a `<strong>` tag. Learn more about the [strong element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong).
|
|
3350
3363
|
*/
|
|
3351
3364
|
| "strong"
|
|
3352
3365
|
/**
|
|
3353
|
-
*
|
|
3366
|
+
* A semantic type that indicates the text is considered less important than the main content, but is still necessary for the reader to understand.
|
|
3367
|
+
*
|
|
3354
3368
|
* It can be used for secondary content but also for disclaimers, terms and conditions, or legal information.
|
|
3355
3369
|
*
|
|
3356
3370
|
* Surfaces should apply a smaller font size than the default size.
|
|
3357
3371
|
*
|
|
3358
|
-
* In an HTML host, the text will be rendered in a `<small>` element.
|
|
3359
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small
|
|
3372
|
+
* In an HTML host, the text will be rendered in a `<small>` element. Learn more about the [small element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/small).
|
|
3360
3373
|
*/
|
|
3361
3374
|
| "small"
|
|
3362
3375
|
/**
|
|
@@ -3364,8 +3377,7 @@ export type TextType =
|
|
|
3364
3377
|
*
|
|
3365
3378
|
* Surfaces must not apply any default styling to this type.
|
|
3366
3379
|
*
|
|
3367
|
-
* In an HTML host, the text will be rendered in a `<span>` tag.
|
|
3368
|
-
* @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span
|
|
3380
|
+
* In an HTML host, the text will be rendered in a `<span>` tag. Learn more about the [span element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span).
|
|
3369
3381
|
*/
|
|
3370
3382
|
| "generic";
|
|
3371
3383
|
interface TextAreaProps$1 extends GlobalProps, BaseTextFieldProps, MinMaxLengthProps, AutocompleteProps<TextAutocompleteField> {
|
|
@@ -3380,15 +3392,13 @@ interface TextFieldProps$1 extends GlobalProps, BaseTextFieldProps, MinMaxLength
|
|
|
3380
3392
|
}
|
|
3381
3393
|
interface TimeProps$1 extends GlobalProps {
|
|
3382
3394
|
/**
|
|
3383
|
-
* The content
|
|
3395
|
+
* The text content displayed within the time component, representing a human-readable date or time value.
|
|
3384
3396
|
*/
|
|
3385
3397
|
children?: ComponentChildren;
|
|
3386
3398
|
/**
|
|
3387
|
-
*
|
|
3388
|
-
*
|
|
3389
|
-
* It must be a [valid date string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values).
|
|
3399
|
+
* The machine-readable date and/or time value for the element. Use this to provide a datetime string that browsers, search engines, and assistive technologies can parse for improved semantics and functionality.
|
|
3390
3400
|
*
|
|
3391
|
-
*
|
|
3401
|
+
* The value must be a [valid datetime string](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/time#valid_datetime_values), such as `2024-01-15`, `14:30`, or `2024-01-15T14:30:00`.
|
|
3392
3402
|
*
|
|
3393
3403
|
* @default ''
|
|
3394
3404
|
*/
|
|
@@ -3396,7 +3406,7 @@ interface TimeProps$1 extends GlobalProps {
|
|
|
3396
3406
|
}
|
|
3397
3407
|
interface TooltipProps$1 extends GlobalProps {
|
|
3398
3408
|
/**
|
|
3399
|
-
* The
|
|
3409
|
+
* The text or elements displayed inside the tooltip popup.
|
|
3400
3410
|
*/
|
|
3401
3411
|
children?: ComponentChildren;
|
|
3402
3412
|
}
|