{ "schemaVersion": "2.1.0", "readme": "Polaris Web Components - Custom Elements Manifest", "modules": [ { "kind": "javascript-module", "path": "dist/components/Avatar/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Avatar", "members": [ { "kind": "field", "name": "size", "type": { "text": "\"base\" | \"small\" | \"small-200\" | \"large\" | \"large-200\"" }, "description": "Size of the avatar." }, { "kind": "field", "name": "alt", "type": { "text": "string" }, "description": "An alternative text that describes the avatar for the reader to understand what it is about or identify the user the avatar belongs to." }, { "kind": "field", "name": "src", "type": { "text": "string" }, "description": "The URL or path to the image. Initials will be rendered as a fallback if `src` is not provided, fails to load or does not load quickly" }, { "kind": "field", "name": "initials", "type": { "text": "string" }, "description": "Initials to display in the avatar." } ], "events": [ { "name": "load", "type": { "text": "Event" } }, { "name": "error", "type": { "text": "Event" } } ], "attributes": [ { "name": "size", "fieldName": "size", "type": { "text": "\"base\" | \"small\" | \"small-200\" | \"large\" | \"large-200\"" }, "description": "Size of the avatar." }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "description": "An alternative text that describes the avatar for the reader to understand what it is about or identify the user the avatar belongs to." }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "description": "The URL or path to the image. Initials will be rendered as a fallback if `src` is not provided, fails to load or does not load quickly" }, { "name": "initials", "fieldName": "initials", "type": { "text": "string" }, "description": "Initials to display in the avatar." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-avatar" } ] }, { "kind": "javascript-module", "path": "dist/components/Badge/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Badge", "slots": [ { "name": "", "description": "The content of the Badge." } ], "members": [ { "kind": "field", "name": "color", "type": { "text": "\"base\" | \"strong\"" }, "description": "Modify the color to be more or less intense." }, { "kind": "field", "name": "icon", "type": { "text": "\"color\" | \"info\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"channels-filled\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\"" }, "description": "The type of icon to be displayed in the badge." }, { "kind": "field", "name": "size", "type": { "text": "\"base\" | \"large\" | \"large-100\"" }, "description": "Adjusts the size." }, { "kind": "field", "name": "tone", "type": { "text": "\"auto\" | \"neutral\" | \"info\" | \"success\" | \"caution\" | \"warning\" | \"critical\"" }, "description": "Sets the tone of the Badge, based on the intention of the information being conveyed." } ], "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "\"base\" | \"strong\"" }, "description": "Modify the color to be more or less intense." }, { "name": "icon", "fieldName": "icon", "type": { "text": "\"color\" | \"info\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"channels-filled\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\"" }, "description": "The type of icon to be displayed in the badge." }, { "name": "size", "fieldName": "size", "type": { "text": "\"base\" | \"large\" | \"large-100\"" }, "description": "Adjusts the size." }, { "name": "tone", "fieldName": "tone", "type": { "text": "\"auto\" | \"neutral\" | \"info\" | \"success\" | \"caution\" | \"warning\" | \"critical\"" }, "description": "Sets the tone of the Badge, based on the intention of the information being conveyed." } ], "superclass": { "name": "BadgeBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Badge/BadgeBase" }, "customElement": true, "tagName": "s-badge" } ] }, { "kind": "javascript-module", "path": "dist/components/Banner/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Banner", "slots": [ { "name": "", "description": "The content of the Banner." }, { "name": "secondary-actions", "description": "The secondary actions to display at the bottom of the Banner. Only Buttons with the `variant` of \"secondary\" or \"auto\" are permitted. A maximum of two `s-button` components are allowed." } ], "members": [ { "kind": "field", "name": "tone", "type": { "text": "\"auto\" | \"info\" | \"success\" | \"warning\" | \"critical\"" }, "description": "Sets the tone of the Banner, based on the intention of the information being conveyed. The banner is a live region and the type of status will be dictated by the Tone selected. - `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. - `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." }, { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the banner is hidden. If this property is being set on each framework render (as in 'controlled' usage), and the banner is `dismissible`, ensure you update app state for this property when the `dismiss` event fires. If the banner is not `dismissible`, it can still be hidden by setting this property." }, { "kind": "field", "name": "heading", "type": { "text": "string" }, "default": "''", "description": "The title of the banner." }, { "kind": "field", "name": "dismissible", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the close button of the banner is present. When the close button is pressed, the `dismiss` event will fire, then `hidden` will be true, any animation will complete, and the `afterhide` event will fire." } ], "events": [ { "name": "dismiss", "type": { "text": "CustomEvent" } }, { "name": "afterhide", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "tone", "fieldName": "tone", "type": { "text": "\"auto\" | \"info\" | \"success\" | \"warning\" | \"critical\"" }, "description": "Sets the tone of the Banner, based on the intention of the information being conveyed. The banner is a live region and the type of status will be dictated by the Tone selected. - `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. - `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." }, { "name": "hidden", "fieldName": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the banner is hidden. If this property is being set on each framework render (as in 'controlled' usage), and the banner is `dismissible`, ensure you update app state for this property when the `dismiss` event fires. If the banner is not `dismissible`, it can still be hidden by setting this property." }, { "name": "heading", "fieldName": "heading", "type": { "text": "string" }, "default": "''", "description": "The title of the banner." }, { "name": "dismissible", "fieldName": "dismissible", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the close button of the banner is present. When the close button is pressed, the `dismiss` event will fire, then `hidden` will be true, any animation will complete, and the `afterhide` event will fire." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-banner" } ] }, { "kind": "javascript-module", "path": "dist/components/Box/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Box", "slots": [ { "name": "", "description": "The content of the Box." } ], "members": [ { "kind": "field", "name": "background", "type": { "text": "\"subdued\" | \"base\" | \"strong\" | \"transparent\"" }, "default": "'transparent'", "description": "Adjust the background of the component." }, { "kind": "field", "name": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." }, { "kind": "field", "name": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "kind": "field", "name": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "kind": "field", "name": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "kind": "field", "name": "padding", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust the padding of all edges. [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is: - 4 values: `block-start inline-end block-end inline-start` - 3 values: `block-start inline block-end` - 2 values: `block inline` For example: - `large` means block-start, inline-end, block-end and inline-start paddings are `large`. - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`. - `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`. - `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`. A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. `padding` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlock", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the block-padding. - `large none` means block-start padding is `large`, block-end padding is `none`. This overrides the block value of `padding`. `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlockStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-start padding. This overrides the block-start value of `paddingBlock`. `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlockEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-end padding. This overrides the block-end value of `paddingBlock`. `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInline", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the inline padding. - `large none` means inline-start padding is `large`, inline-end padding is `none`. This overrides the inline value of `padding`. `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInlineStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-start padding. This overrides the inline-start value of `paddingInline`. `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInlineEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-end padding. This overrides the inline-end value of `paddingInline`. `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "display", "type": { "text": "\"auto\" | \"none\"" }, "default": "'auto'", "description": "Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers." }, { "kind": "field", "name": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size)." }, { "kind": "field", "name": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size)." }, { "kind": "field", "name": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size)." }, { "kind": "field", "name": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size)." }, { "kind": "field", "name": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size)." }, { "kind": "field", "name": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size)." }, { "kind": "field", "name": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context. Only use this when the element's content is not enough context for users using assistive technologies." }, { "kind": "field", "name": "accessibilityRole", "type": { "text": "\"generic\" | \"status\" | \"main\" | \"header\" | \"footer\" | \"section\" | \"region\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"alert\" | \"presentation\" | \"none\"" }, "default": "'generic'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page." }, { "kind": "field", "name": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "kind": "field", "name": "overflow", "type": { "text": "\"visible\" | \"hidden\"" }, "default": "'visible'", "description": "Sets the overflow behavior of the element. - `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse. - `visible`: the content that extends beyond the element’s container is visible." } ], "attributes": [ { "name": "background", "fieldName": "background", "type": { "text": "\"subdued\" | \"base\" | \"strong\" | \"transparent\"" }, "default": "'transparent'", "description": "Adjust the background of the component." }, { "name": "borderwidth", "fieldName": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." }, { "name": "borderstyle", "fieldName": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "name": "bordercolor", "fieldName": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "name": "borderradius", "fieldName": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "name": "padding", "fieldName": "padding", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust the padding of all edges. [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is: - 4 values: `block-start inline-end block-end inline-start` - 3 values: `block-start inline block-end` - 2 values: `block inline` For example: - `large` means block-start, inline-end, block-end and inline-start paddings are `large`. - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`. - `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`. - `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`. A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. `padding` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblock", "fieldName": "paddingBlock", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the block-padding. - `large none` means block-start padding is `large`, block-end padding is `none`. This overrides the block value of `padding`. `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblockstart", "fieldName": "paddingBlockStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-start padding. This overrides the block-start value of `paddingBlock`. `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblockend", "fieldName": "paddingBlockEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-end padding. This overrides the block-end value of `paddingBlock`. `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginline", "fieldName": "paddingInline", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the inline padding. - `large none` means inline-start padding is `large`, inline-end padding is `none`. This overrides the inline value of `padding`. `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginlinestart", "fieldName": "paddingInlineStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-start padding. This overrides the inline-start value of `paddingInline`. `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginlineend", "fieldName": "paddingInlineEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-end padding. This overrides the inline-end value of `paddingInline`. `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "display", "fieldName": "display", "type": { "text": "\"auto\" | \"none\"" }, "default": "'auto'", "description": "Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers." }, { "name": "blocksize", "fieldName": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size)." }, { "name": "minblocksize", "fieldName": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size)." }, { "name": "maxblocksize", "fieldName": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size)." }, { "name": "inlinesize", "fieldName": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size)." }, { "name": "mininlinesize", "fieldName": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size)." }, { "name": "maxinlinesize", "fieldName": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size)." }, { "name": "accessibilityvisibility", "fieldName": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context. Only use this when the element's content is not enough context for users using assistive technologies." }, { "name": "accessibilityrole", "fieldName": "accessibilityRole", "type": { "text": "\"generic\" | \"status\" | \"main\" | \"header\" | \"footer\" | \"section\" | \"region\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"alert\" | \"presentation\" | \"none\"" }, "default": "'generic'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page." }, { "name": "border", "fieldName": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "name": "overflow", "fieldName": "overflow", "type": { "text": "\"visible\" | \"hidden\"" }, "default": "'visible'", "description": "Sets the overflow behavior of the element. - `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse. - `visible`: the content that extends beyond the element’s container is visible." } ], "superclass": { "name": "BoxElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/BoxElement" }, "customElement": true, "tagName": "s-box" } ] }, { "kind": "javascript-module", "path": "dist/components/Button/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Button", "slots": [ { "name": "", "description": "The content of the Button." } ], "members": [ { "kind": "field", "name": "tone", "type": { "text": "\"auto\" | \"neutral\" | \"critical\"" }, "description": "Sets the tone of the Button based on the intention of the information being conveyed." }, { "kind": "field", "name": "icon", "type": { "text": "\"color\" | \"info\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"channels-filled\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\"" }, "description": "The type of icon to be displayed in the Button." }, { "kind": "field", "name": "type", "type": { "text": "\"button\" | \"reset\" | \"submit\"" }, "default": "'button'", "description": "The behavior of the Button. - `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form. - `button`: Used to indicate the component acts as a button, meaning it has no default action. - `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values). This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set." }, { "kind": "field", "name": "interestFor", "type": { "text": "string" }, "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the Button meaning it cannot be clicked or receive focus." }, { "kind": "field", "name": "download", "type": { "text": "string" }, "description": "Causes the browser to treat the linked URL as a download with the string being the file name. Download only works for same-origin URLs or the `blob:` and `data:` schemes." }, { "kind": "field", "name": "target", "type": { "text": "\"auto\" | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"" }, "default": "'auto'", "description": "Specifies where to display the linked URL." }, { "kind": "field", "name": "variant", "type": { "text": "\"auto\" | \"primary\" | \"secondary\" | \"tertiary\"" }, "default": "'auto' - the variant is automatically determined by the Button's context", "description": "Changes the visual appearance of the Button." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers. Use this when using only an icon or the Button text is not enough context for users using assistive technologies." }, { "kind": "field", "name": "inlineSize", "type": { "text": "\"auto\" | \"fill\" | \"fit-content\"" }, "default": "'auto'", "description": "The displayed inline width of the Button. - `auto`: the size of the button depends on the surface and context. - `fill`: the button will takes up 100% of the available inline size. - `fit-content`: the button will take up the minimum inline-size required to fit its content." }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)" }, { "kind": "field", "name": "command", "type": { "text": "\"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\"" }, "default": "'--auto'", "description": "Sets the action the `commandFor` should take when this clickable is activated. See the documentation of particular components for the actions they support. - `--auto`: a default action for the target component. - `--show`: shows the target component. - `--hide`: hides the target component. - `--toggle`: toggles the target component. - `--copy`: copies the target ClipboardItem." }, { "kind": "field", "name": "commandFor", "type": { "text": "string" }, "description": "ID of a component that should respond to activations (e.g. clicks) on this component. See `command` for how to control the behavior of the target." }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Replaces content with a loading indicator while a background action is being performed. This also disables the Button." }, { "kind": "field", "name": "href", "type": { "text": "string" }, "description": "The URL to link to. - If set, it will navigate to the location specified by `href` after executing the `click` event. - If a `commandFor` is set, the `command` will be executed instead of the navigation." } ], "events": [ { "name": "click", "type": { "text": "CustomEvent" } }, { "name": "focus", "type": { "text": "CustomEvent" } }, { "name": "blur", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "tone", "fieldName": "tone", "type": { "text": "\"auto\" | \"neutral\" | \"critical\"" }, "description": "Sets the tone of the Button based on the intention of the information being conveyed." }, { "name": "icon", "fieldName": "icon", "type": { "text": "\"color\" | \"info\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"channels-filled\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\"" }, "description": "The type of icon to be displayed in the Button." }, { "name": "type", "fieldName": "type", "type": { "text": "\"button\" | \"reset\" | \"submit\"" }, "default": "'button'", "description": "The behavior of the Button. - `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form. - `button`: Used to indicate the component acts as a button, meaning it has no default action. - `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values). This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set." }, { "name": "interestfor", "fieldName": "interestFor", "type": { "text": "string" }, "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the Button meaning it cannot be clicked or receive focus." }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "description": "Causes the browser to treat the linked URL as a download with the string being the file name. Download only works for same-origin URLs or the `blob:` and `data:` schemes." }, { "name": "target", "fieldName": "target", "type": { "text": "\"auto\" | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"" }, "default": "'auto'", "description": "Specifies where to display the linked URL." }, { "name": "variant", "fieldName": "variant", "type": { "text": "\"auto\" | \"primary\" | \"secondary\" | \"tertiary\"" }, "default": "'auto' - the variant is automatically determined by the Button's context", "description": "Changes the visual appearance of the Button." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers. Use this when using only an icon or the Button text is not enough context for users using assistive technologies." }, { "name": "inlinesize", "fieldName": "inlineSize", "type": { "text": "\"auto\" | \"fill\" | \"fit-content\"" }, "default": "'auto'", "description": "The displayed inline width of the Button. - `auto`: the size of the button depends on the surface and context. - `fill`: the button will takes up 100% of the available inline size. - `fit-content`: the button will take up the minimum inline-size required to fit its content." }, { "name": "lang", "fieldName": "lang", "type": { "text": "string" }, "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)" }, { "name": "command", "fieldName": "command", "type": { "text": "\"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\"" }, "default": "'--auto'", "description": "Sets the action the `commandFor` should take when this clickable is activated. See the documentation of particular components for the actions they support. - `--auto`: a default action for the target component. - `--show`: shows the target component. - `--hide`: hides the target component. - `--toggle`: toggles the target component. - `--copy`: copies the target ClipboardItem." }, { "name": "commandfor", "fieldName": "commandFor", "type": { "text": "string" }, "description": "ID of a component that should respond to activations (e.g. clicks) on this component. See `command` for how to control the behavior of the target." }, { "name": "loading", "fieldName": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Replaces content with a loading indicator while a background action is being performed. This also disables the Button." }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "description": "The URL to link to. - If set, it will navigate to the location specified by `href` after executing the `click` event. - If a `commandFor` is set, the `command` will be executed instead of the navigation." } ], "superclass": { "name": "ButtonBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Button/ButtonBase" }, "customElement": true, "tagName": "s-button" } ] }, { "kind": "javascript-module", "path": "dist/components/ButtonGroup/index.js", "declarations": [ { "kind": "class", "description": "", "name": "ButtonGroup", "slots": [ { "name": "", "description": "The content of the ButtonGroup." }, { "name": "primary-action", "description": "The primary action button for the group. Accepts a single Button element with a `variant` of `primary`. Cannot be used when gap=\"none\"." }, { "name": "secondary-actions", "description": "Secondary action buttons for the group. Accepts Button or PressButton elements with a `variant` of `secondary` or `auto`." } ], "members": [ { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "Label for the button group that describes the content of the group for screen reader users to understand what's included." }, { "kind": "field", "name": "gap", "type": { "text": "\"base\" | \"none\"" }, "default": "'base'", "description": "The gap between elements." } ], "attributes": [ { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "Label for the button group that describes the content of the group for screen reader users to understand what's included." }, { "name": "gap", "fieldName": "gap", "type": { "text": "\"base\" | \"none\"" }, "default": "'base'", "description": "The gap between elements." } ], "superclass": { "name": "ButtonGroupBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/ButtonGroup/ButtonGroupBase" }, "customElement": true, "tagName": "s-button-group" } ] }, { "kind": "javascript-module", "path": "dist/components/Checkbox/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Checkbox", "slots": [ { "name": "error" }, { "name": "details" } ], "members": [ { "kind": "field", "name": "indeterminate", "type": { "text": "boolean" } }, { "kind": "field", "name": "defaultIndeterminate", "type": { "text": "boolean" } }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" } }, { "kind": "field", "name": "value", "type": { "text": "string" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the control, disallowing any interaction." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the control that is unique within the nearest containing `Form` component." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Visual content to use as the control label." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active." }, { "kind": "field", "name": "defaultChecked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active by default." } ], "events": [ { "name": "change", "type": { "text": "CustomEvent" } }, { "name": "input", "type": { "text": "CustomEvent" } }, { "name": "blur", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "indeterminate", "fieldName": "indeterminate", "type": { "text": "boolean" } }, { "name": "indeterminate", "fieldName": "defaultIndeterminate", "type": { "text": "boolean" } }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" } }, { "name": "value", "fieldName": "value", "type": { "text": "string" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the control, disallowing any interaction." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the control that is unique within the nearest containing `Form` component." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Visual content to use as the control label." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "checked", "fieldName": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active." }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active by default." } ], "superclass": { "name": "CheckboxBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Checkbox/CheckboxBase" }, "customElement": true, "tagName": "s-checkbox" } ] }, { "kind": "javascript-module", "path": "dist/components/Chip/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Chip", "slots": [ { "name": "", "description": "The content of the Chip." }, { "name": "graphic", "description": "The graphic to display in the chip. Only accepts `Icon` components." } ], "members": [ { "kind": "field", "name": "color", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'base'", "description": "Modify the color to be more or less intense." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers." }, { "kind": "field", "name": "removable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the chip is removable." } ], "events": [ { "name": "remove", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'base'", "description": "Modify the color to be more or less intense." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers." }, { "name": "removable", "fieldName": "removable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the chip is removable." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-chip" } ] }, { "kind": "javascript-module", "path": "dist/components/Choice/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Choice", "slots": [ { "name": "", "description": "Content to use as the choice label. The label is produced by extracting and concatenating the text nodes from the provided content; any markup or element structure is ignored." }, { "name": "details", "description": "Additional text to provide context or guidance for the input. This text is displayed along with the input and its label to offer more information or instructions to the user." }, { "name": "secondary-content", "description": "Additional content to display below the choice label. Can include rich content like TextFields, Buttons, or other interactive components. Event handlers on React components are preserved." } ], "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the control, disallowing any interaction." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The value used in form data when the control is checked." }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active." }, { "kind": "field", "name": "defaultSelected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active by default." } ], "attributes": [ { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the control, disallowing any interaction." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "description": "The value used in form data when the control is checked." }, { "name": "selected", "fieldName": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active." }, { "name": "selected", "fieldName": "defaultSelected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active by default." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-choice" } ] }, { "kind": "javascript-module", "path": "dist/components/ChoiceList/index.js", "declarations": [ { "kind": "class", "description": "", "name": "ChoiceList", "slots": [ { "name": "", "description": "The choices a user can select from. Accepts `Choice` components." } ], "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction. `disabled` on any child choices is ignored when this is true." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Whether multiple choices can be selected." }, { "kind": "field", "name": "values", "type": { "text": "string[]" }, "description": "An array of the `value`s of the selected options. This is a convenience prop for setting the `selected` prop on child options." }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "BaseClass", "module": "/home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/ChoiceList/index.ts" } }, { "kind": "field", "name": "[internals]", "type": { "text": "ElementInternals" }, "privacy": "private", "inheritedFrom": { "name": "BaseClass", "module": "/home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/ChoiceList/index.ts" } }, { "kind": "field", "inheritedFrom": { "name": "BaseClass", "module": "/home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/ChoiceList/index.ts" } } ], "events": [ { "name": "change", "type": { "text": "CustomEvent" } }, { "name": "input", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction. `disabled` on any child choices is ignored when this is true." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Whether multiple choices can be selected." }, { "name": "values", "fieldName": "values", "type": { "text": "string[]" }, "description": "An array of the `value`s of the selected options. This is a convenience prop for setting the `selected` prop on child options." } ], "superclass": { "name": "BaseClass", "module": "/home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/ChoiceList/index.ts" }, "customElement": true, "tagName": "s-choice-list" } ] }, { "kind": "javascript-module", "path": "dist/components/Clickable/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Clickable", "slots": [ { "name": "", "description": "The content of the Clickable." } ], "members": [ { "kind": "field", "name": "background", "type": { "text": "\"subdued\" | \"base\" | \"strong\" | \"transparent\"" }, "default": "'transparent'", "description": "Adjust the background of the component." }, { "kind": "field", "name": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." }, { "kind": "field", "name": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "kind": "field", "name": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "kind": "field", "name": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "kind": "field", "name": "padding", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust the padding of all edges. [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is: - 4 values: `block-start inline-end block-end inline-start` - 3 values: `block-start inline block-end` - 2 values: `block inline` For example: - `large` means block-start, inline-end, block-end and inline-start paddings are `large`. - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`. - `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`. - `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`. A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. `padding` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlock", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the block-padding. - `large none` means block-start padding is `large`, block-end padding is `none`. This overrides the block value of `padding`. `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlockStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-start padding. This overrides the block-start value of `paddingBlock`. `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlockEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-end padding. This overrides the block-end value of `paddingBlock`. `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInline", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the inline padding. - `large none` means inline-start padding is `large`, inline-end padding is `none`. This overrides the inline value of `padding`. `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInlineStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-start padding. This overrides the inline-start value of `paddingInline`. `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInlineEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-end padding. This overrides the inline-end value of `paddingInline`. `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "display", "type": { "text": "\"auto\" | \"none\"" }, "default": "'auto'", "description": "Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers." }, { "kind": "field", "name": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size)." }, { "kind": "field", "name": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size)." }, { "kind": "field", "name": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size)." }, { "kind": "field", "name": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size)." }, { "kind": "field", "name": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size)." }, { "kind": "field", "name": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size)." }, { "kind": "field", "name": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context. Only use this when the element's content is not enough context for users using assistive technologies." }, { "kind": "field", "name": "accessibilityRole", "type": { "text": "\"generic\" | \"status\" | \"main\" | \"header\" | \"footer\" | \"section\" | \"region\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"alert\" | \"presentation\" | \"none\"" }, "default": "'generic'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page." }, { "kind": "field", "name": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "kind": "field", "name": "overflow", "type": { "text": "\"visible\" | \"hidden\"" }, "default": "'visible'", "description": "Sets the overflow behavior of the element. - `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse. - `visible`: the content that extends beyond the element’s container is visible." }, { "kind": "field", "name": "type", "type": { "text": "\"button\" | \"reset\" | \"submit\"" }, "default": "'button'", "description": "The behavior of the Button. - `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form. - `button`: Used to indicate the component acts as a button, meaning it has no default action. - `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values). This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set." }, { "kind": "field", "name": "interestFor", "type": { "text": "string" }, "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "description": "Disables the clickable, meaning it cannot be clicked or receive focus. In this state, onClick will not fire. If the click event originates from a child element, the event will immediately stop propagating from this element. However, items within the clickable can still receive focus and be interacted with. This has no impact on the visual state by default, but developers are encouraged to style the clickable accordingly." }, { "kind": "field", "name": "download", "type": { "text": "string" }, "description": "Causes the browser to treat the linked URL as a download with the string being the file name. Download only works for same-origin URLs or the `blob:` and `data:` schemes." }, { "kind": "field", "name": "target", "type": { "text": "\"auto\" | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"" }, "default": "'auto'", "description": "Specifies where to display the linked URL." }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "default": "''", "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)" }, { "kind": "field", "name": "command", "type": { "text": "\"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\"" }, "default": "'--auto'", "description": "Sets the action the `commandFor` should take when this clickable is activated. See the documentation of particular components for the actions they support. - `--auto`: a default action for the target component. - `--show`: shows the target component. - `--hide`: hides the target component. - `--toggle`: toggles the target component. - `--copy`: copies the target ClipboardItem." }, { "kind": "field", "name": "commandFor", "type": { "text": "string" }, "description": "ID of a component that should respond to activations (e.g. clicks) on this component. See `command` for how to control the behavior of the target." }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "description": "Disables the clickable, and indicates to assistive technology that the loading is in progress. This also disables the clickable." }, { "kind": "field", "name": "href", "type": { "text": "string" }, "description": "The URL to link to. - If set, it will navigate to the location specified by `href` after executing the `click` event. - If a `commandFor` is set, the `command` will be executed instead of the navigation." } ], "events": [ { "name": "click", "type": { "text": "CustomEvent" } }, { "name": "focus", "type": { "text": "CustomEvent" } }, { "name": "blur", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "background", "fieldName": "background", "type": { "text": "\"subdued\" | \"base\" | \"strong\" | \"transparent\"" }, "default": "'transparent'", "description": "Adjust the background of the component." }, { "name": "borderwidth", "fieldName": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." }, { "name": "borderstyle", "fieldName": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "name": "bordercolor", "fieldName": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "name": "borderradius", "fieldName": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "name": "padding", "fieldName": "padding", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust the padding of all edges. [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is: - 4 values: `block-start inline-end block-end inline-start` - 3 values: `block-start inline block-end` - 2 values: `block inline` For example: - `large` means block-start, inline-end, block-end and inline-start paddings are `large`. - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`. - `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`. - `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`. A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. `padding` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblock", "fieldName": "paddingBlock", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the block-padding. - `large none` means block-start padding is `large`, block-end padding is `none`. This overrides the block value of `padding`. `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblockstart", "fieldName": "paddingBlockStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-start padding. This overrides the block-start value of `paddingBlock`. `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblockend", "fieldName": "paddingBlockEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-end padding. This overrides the block-end value of `paddingBlock`. `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginline", "fieldName": "paddingInline", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the inline padding. - `large none` means inline-start padding is `large`, inline-end padding is `none`. This overrides the inline value of `padding`. `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginlinestart", "fieldName": "paddingInlineStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-start padding. This overrides the inline-start value of `paddingInline`. `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginlineend", "fieldName": "paddingInlineEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-end padding. This overrides the inline-end value of `paddingInline`. `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "display", "fieldName": "display", "type": { "text": "\"auto\" | \"none\"" }, "default": "'auto'", "description": "Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers." }, { "name": "blocksize", "fieldName": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size)." }, { "name": "minblocksize", "fieldName": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size)." }, { "name": "maxblocksize", "fieldName": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size)." }, { "name": "inlinesize", "fieldName": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size)." }, { "name": "mininlinesize", "fieldName": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size)." }, { "name": "maxinlinesize", "fieldName": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size)." }, { "name": "accessibilityvisibility", "fieldName": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context. Only use this when the element's content is not enough context for users using assistive technologies." }, { "name": "accessibilityrole", "fieldName": "accessibilityRole", "type": { "text": "\"generic\" | \"status\" | \"main\" | \"header\" | \"footer\" | \"section\" | \"region\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"alert\" | \"presentation\" | \"none\"" }, "default": "'generic'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page." }, { "name": "border", "fieldName": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "name": "overflow", "fieldName": "overflow", "type": { "text": "\"visible\" | \"hidden\"" }, "default": "'visible'", "description": "Sets the overflow behavior of the element. - `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse. - `visible`: the content that extends beyond the element’s container is visible." }, { "name": "type", "fieldName": "type", "type": { "text": "\"button\" | \"reset\" | \"submit\"" }, "default": "'button'", "description": "The behavior of the Button. - `submit`: Used to indicate the component acts as a submit button, meaning it submits the closest form. - `button`: Used to indicate the component acts as a button, meaning it has no default action. - `reset`: Used to indicate the component acts as a reset button, meaning it resets the closest form (returning fields to their default values). This property is ignored if the component supports `href` or `commandFor`/`command` and one of them is set." }, { "name": "interestfor", "fieldName": "interestFor", "type": { "text": "string" }, "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "description": "Disables the clickable, meaning it cannot be clicked or receive focus. In this state, onClick will not fire. If the click event originates from a child element, the event will immediately stop propagating from this element. However, items within the clickable can still receive focus and be interacted with. This has no impact on the visual state by default, but developers are encouraged to style the clickable accordingly." }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "description": "Causes the browser to treat the linked URL as a download with the string being the file name. Download only works for same-origin URLs or the `blob:` and `data:` schemes." }, { "name": "target", "fieldName": "target", "type": { "text": "\"auto\" | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"" }, "default": "'auto'", "description": "Specifies where to display the linked URL." }, { "name": "lang", "fieldName": "lang", "type": { "text": "string" }, "default": "''", "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)" }, { "name": "command", "fieldName": "command", "type": { "text": "\"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\"" }, "default": "'--auto'", "description": "Sets the action the `commandFor` should take when this clickable is activated. See the documentation of particular components for the actions they support. - `--auto`: a default action for the target component. - `--show`: shows the target component. - `--hide`: hides the target component. - `--toggle`: toggles the target component. - `--copy`: copies the target ClipboardItem." }, { "name": "commandfor", "fieldName": "commandFor", "type": { "text": "string" }, "description": "ID of a component that should respond to activations (e.g. clicks) on this component. See `command` for how to control the behavior of the target." }, { "name": "loading", "fieldName": "loading", "type": { "text": "boolean" }, "description": "Disables the clickable, and indicates to assistive technology that the loading is in progress. This also disables the clickable." }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "description": "The URL to link to. - If set, it will navigate to the location specified by `href` after executing the `click` event. - If a `commandFor` is set, the `command` will be executed instead of the navigation." } ], "mixins": [ { "name": "PreactOverlayControl", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/mixins/PreactOverlayControl" } ], "superclass": { "name": "BoxElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/BoxElement" }, "customElement": true, "tagName": "s-clickable" } ] }, { "kind": "javascript-module", "path": "dist/components/ClickableChip/index.js", "declarations": [ { "kind": "class", "description": "", "name": "ClickableChip", "slots": [ { "name": "", "description": "The content of the clickable chip." }, { "name": "graphic", "description": "The graphic to display in the clickable chip. Only accepts `Icon` components." } ], "members": [ { "kind": "field", "name": "color", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'base'", "description": "Modify the color to be more or less intense." }, { "kind": "field", "name": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the chip is hidden. If this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires. If the chip is not `removable`, it can still be hidden by setting this property." }, { "kind": "field", "name": "interestFor", "type": { "text": "string" }, "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the chip, disallowing any interaction." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers." }, { "kind": "field", "name": "command", "type": { "text": "\"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\"" }, "default": "'--auto'", "description": "Sets the action the `commandFor` should take when this clickable is activated. See the documentation of particular components for the actions they support. - `--auto`: a default action for the target component. - `--show`: shows the target component. - `--hide`: hides the target component. - `--toggle`: toggles the target component. - `--copy`: copies the target ClipboardItem." }, { "kind": "field", "name": "commandFor", "type": { "text": "string" }, "description": "ID of a component that should respond to activations (e.g. clicks) on this component. See `command` for how to control the behavior of the target." }, { "kind": "field", "name": "href", "type": { "text": "string" }, "description": "The URL to link to. - If set, it will navigate to the location specified by `href` after executing the `click` event. - If a `commandFor` is set, the `command` will be executed instead of the navigation." }, { "kind": "field", "name": "removable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the chip is removable." } ], "events": [ { "name": "click", "type": { "text": "CustomEvent" } }, { "name": "remove", "type": { "text": "CustomEvent" } }, { "name": "afterhide", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'base'", "description": "Modify the color to be more or less intense." }, { "name": "hidden", "fieldName": "hidden", "type": { "text": "boolean" }, "default": "false", "description": "Determines whether the chip is hidden. If this property is being set on each framework render (as in 'controlled' usage), and the chip is `removable`, ensure you update app state for this property when the `remove` event fires. If the chip is not `removable`, it can still be hidden by setting this property." }, { "name": "interestfor", "fieldName": "interestFor", "type": { "text": "string" }, "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the chip, disallowing any interaction." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the Chip. It will be read to users using assistive technologies such as screen readers." }, { "name": "command", "fieldName": "command", "type": { "text": "\"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\"" }, "default": "'--auto'", "description": "Sets the action the `commandFor` should take when this clickable is activated. See the documentation of particular components for the actions they support. - `--auto`: a default action for the target component. - `--show`: shows the target component. - `--hide`: hides the target component. - `--toggle`: toggles the target component. - `--copy`: copies the target ClipboardItem." }, { "name": "commandfor", "fieldName": "commandFor", "type": { "text": "string" }, "description": "ID of a component that should respond to activations (e.g. clicks) on this component. See `command` for how to control the behavior of the target." }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "description": "The URL to link to. - If set, it will navigate to the location specified by `href` after executing the `click` event. - If a `commandFor` is set, the `command` will be executed instead of the navigation." }, { "name": "removable", "fieldName": "removable", "type": { "text": "boolean" }, "default": "false", "description": "Whether the chip is removable." } ], "superclass": { "name": "ClickableChipBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/ClickableChip/ClickableChipBase" }, "customElement": true, "tagName": "s-clickable-chip" } ] }, { "kind": "javascript-module", "path": "dist/components/ColorField/index.js", "declarations": [ { "kind": "class", "description": "", "name": "ColorField", "slots": [ { "name": "error" }, { "name": "details" } ], "members": [ { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "autocomplete", "type": { "text": "\"on\" | \"off\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "kind": "field", "name": "alpha", "type": { "text": "boolean" }, "default": "false", "description": "Allow user to select an alpha value." } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user makes changes to the field value. This fires before `onChange`." }, { "name": "change", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user has finished editing the field, such as when they blur the field." }, { "name": "focus", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field receives focus." }, { "name": "blur", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field loses focus." } ], "attributes": [ { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "name": "value", "fieldName": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "\"on\" | \"off\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "name": "alpha", "fieldName": "alpha", "type": { "text": "boolean" }, "default": "false", "description": "Allow user to select an alpha value." } ], "superclass": { "name": "ColorFieldBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/ColorField/ColorFieldBase" }, "customElement": true, "tagName": "s-color-field" } ] }, { "kind": "javascript-module", "path": "dist/components/ColorPicker/index.js", "declarations": [ { "kind": "class", "description": "", "name": "ColorPicker", "members": [ { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The currently selected color. Supported formats include: - HSL" }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "kind": "field", "name": "alpha", "type": { "text": "boolean" }, "default": "false", "description": "Allow user to select an alpha value." }, { "kind": "field", "name": "formAssociated", "type": { "text": "boolean" }, "static": true, "default": "true", "inheritedFrom": { "name": "BaseClass", "module": "/home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/ChoiceList/index.ts" } }, { "kind": "field", "name": "[internals]", "type": { "text": "ElementInternals" }, "privacy": "private", "inheritedFrom": { "name": "BaseClass", "module": "/home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/ChoiceList/index.ts" } }, { "kind": "field", "inheritedFrom": { "name": "BaseClass", "module": "/home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/ChoiceList/index.ts" } } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" } }, { "name": "change", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "description": "The currently selected color. Supported formats include: - HSL" }, { "name": "value", "fieldName": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "name": "alpha", "fieldName": "alpha", "type": { "text": "boolean" }, "default": "false", "description": "Allow user to select an alpha value." } ], "superclass": { "name": "BaseClass", "module": "/home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/ColorPicker/index.ts" }, "customElement": true, "tagName": "s-color-picker" } ] }, { "kind": "javascript-module", "path": "dist/components/DateField/index.js", "declarations": [ { "kind": "class", "description": "", "name": "DateField", "slots": [ { "name": "error" }, { "name": "details" } ], "members": [ { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "autocomplete", "type": { "text": "\"bday-day\" | \"bday-month\" | \"bday-year\" | \"bday\" | \"cc-expiry-month\" | \"cc-expiry-year\" | \"cc-expiry\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "kind": "field", "name": "view", "type": { "text": "string" }, "description": "Displayed month in `YYYY-MM` format. `onViewChange` is called when this value changes. Defaults to `defaultView`." }, { "kind": "field", "name": "defaultView", "type": { "text": "string" }, "description": "Default month to display in `YYYY-MM` format. This value is used until `view` is set, either directly or as a result of user interaction. Defaults to the current month in the user's locale." }, { "kind": "field", "name": "allow", "type": { "text": "string" }, "default": "\"\"", "description": "Dates that can be selected. A comma-separated list of dates, date ranges. Whitespace is allowed after commas. The default `''` allows all dates. - Dates in `YYYY-MM-DD` format allow a single date. - Dates in `YYYY-MM` format allow a whole month. - Dates in `YYYY` format allow a whole year. - Ranges are expressed as `start--end`. - Ranges are inclusive. - If either `start` or `end` is omitted, the range is unbounded in that direction. - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value. So `2024--` is equivalent to `2024-01-01--`. - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value. So `--2024` is equivalent to `--2024-12-31`. - Whitespace is allowed either side of `--`." }, { "kind": "field", "name": "disallow", "type": { "text": "string" }, "default": "\"\"", "description": "Dates that cannot be selected. These subtract from `allow`. A comma-separated list of dates, date ranges. Whitespace is allowed after commas. The default `''` has no effect on `allow`. - Dates in `YYYY-MM-DD` format disallow a single date. - Dates in `YYYY-MM` format disallow a whole month. - Dates in `YYYY` format disallow a whole year. - Ranges are expressed as `start--end`. - Ranges are inclusive. - If either `start` or `end` is omitted, the range is unbounded in that direction. - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value. So `2024--` is equivalent to `2024-01-01--`. - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value. So `--2024` is equivalent to `--2024-12-31`. - Whitespace is allowed either side of `--`." }, { "kind": "field", "name": "allowDays", "type": { "text": "string" }, "default": "\"\"", "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`. A comma-separated list of days. Whitespace is allowed after commas. The default `''` has no effect on the result of `allow` and `disallow`. Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`." }, { "kind": "field", "name": "disallowDays", "type": { "text": "string" }, "default": "\"\"", "description": "Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`. A comma-separated list of days. Whitespace is allowed after commas. The default `''` has no effect on `allowDays`. Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`." } ], "events": [ { "name": "blur", "type": { "text": "CustomEvent" } }, { "name": "change", "type": { "text": "CustomEvent" } }, { "name": "focus", "type": { "text": "CustomEvent" } }, { "name": "input", "type": { "text": "CustomEvent" } }, { "name": "invalid", "type": { "text": "CustomEvent" } }, { "name": "viewchange", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "name": "value", "fieldName": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "\"bday-day\" | \"bday-month\" | \"bday-year\" | \"bday\" | \"cc-expiry-month\" | \"cc-expiry-year\" | \"cc-expiry\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "name": "view", "fieldName": "view", "type": { "text": "string" }, "description": "Displayed month in `YYYY-MM` format. `onViewChange` is called when this value changes. Defaults to `defaultView`." }, { "name": "view", "fieldName": "defaultView", "type": { "text": "string" }, "description": "Default month to display in `YYYY-MM` format. This value is used until `view` is set, either directly or as a result of user interaction. Defaults to the current month in the user's locale." }, { "name": "allow", "fieldName": "allow", "type": { "text": "string" }, "default": "\"\"", "description": "Dates that can be selected. A comma-separated list of dates, date ranges. Whitespace is allowed after commas. The default `''` allows all dates. - Dates in `YYYY-MM-DD` format allow a single date. - Dates in `YYYY-MM` format allow a whole month. - Dates in `YYYY` format allow a whole year. - Ranges are expressed as `start--end`. - Ranges are inclusive. - If either `start` or `end` is omitted, the range is unbounded in that direction. - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value. So `2024--` is equivalent to `2024-01-01--`. - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value. So `--2024` is equivalent to `--2024-12-31`. - Whitespace is allowed either side of `--`." }, { "name": "disallow", "fieldName": "disallow", "type": { "text": "string" }, "default": "\"\"", "description": "Dates that cannot be selected. These subtract from `allow`. A comma-separated list of dates, date ranges. Whitespace is allowed after commas. The default `''` has no effect on `allow`. - Dates in `YYYY-MM-DD` format disallow a single date. - Dates in `YYYY-MM` format disallow a whole month. - Dates in `YYYY` format disallow a whole year. - Ranges are expressed as `start--end`. - Ranges are inclusive. - If either `start` or `end` is omitted, the range is unbounded in that direction. - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value. So `2024--` is equivalent to `2024-01-01--`. - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value. So `--2024` is equivalent to `--2024-12-31`. - Whitespace is allowed either side of `--`." }, { "name": "allowdays", "fieldName": "allowDays", "type": { "text": "string" }, "default": "\"\"", "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`. A comma-separated list of days. Whitespace is allowed after commas. The default `''` has no effect on the result of `allow` and `disallow`. Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`." }, { "name": "disallowdays", "fieldName": "disallowDays", "type": { "text": "string" }, "default": "\"\"", "description": "Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`. A comma-separated list of days. Whitespace is allowed after commas. The default `''` has no effect on `allowDays`. Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`." } ], "superclass": { "name": "DateFieldBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/DateField/DateFieldBase" }, "customElement": true, "tagName": "s-date-field" } ] }, { "kind": "javascript-module", "path": "dist/components/DatePicker/index.js", "declarations": [ { "kind": "class", "description": "", "name": "DatePicker", "members": [ { "kind": "field", "name": "type", "type": { "text": "\"single\" | \"range\"" } }, { "kind": "field", "name": "view", "type": { "text": "string" }, "description": "Displayed month in `YYYY-MM` format. `onViewChange` is called when this value changes. Defaults to `defaultView`." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "\"\"", "description": "Current selected value. The default means no date is selected. If the provided value is invalid, no date is selected. Otherwise: - If `type=\"single\"`, this is a date in `YYYY-MM-DD` format. - If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format. - If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive." }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "default": "\"\"", "description": "Default selected value. The default means no date is selected. If the provided value is invalid, no date is selected. - If `type=\"single\"`, this is a date in `YYYY-MM-DD` format. - If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format. - If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive." }, { "kind": "field", "name": "defaultView", "type": { "text": "string" }, "description": "Default month to display in `YYYY-MM` format. This value is used until `view` is set, either directly or as a result of user interaction. Defaults to the current month in the user's locale." }, { "kind": "field", "name": "allow", "type": { "text": "string" }, "default": "\"\"", "description": "Dates that can be selected. A comma-separated list of dates, date ranges. Whitespace is allowed after commas. The default `''` allows all dates. - Dates in `YYYY-MM-DD` format allow a single date. - Dates in `YYYY-MM` format allow a whole month. - Dates in `YYYY` format allow a whole year. - Ranges are expressed as `start--end`. - Ranges are inclusive. - If either `start` or `end` is omitted, the range is unbounded in that direction. - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value. So `2024--` is equivalent to `2024-01-01--`. - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value. So `--2024` is equivalent to `--2024-12-31`. - Whitespace is allowed either side of `--`." }, { "kind": "field", "name": "disallow", "type": { "text": "string" }, "default": "\"\"", "description": "Dates that cannot be selected. These subtract from `allow`. A comma-separated list of dates, date ranges. Whitespace is allowed after commas. The default `''` has no effect on `allow`. - Dates in `YYYY-MM-DD` format disallow a single date. - Dates in `YYYY-MM` format disallow a whole month. - Dates in `YYYY` format disallow a whole year. - Ranges are expressed as `start--end`. - Ranges are inclusive. - If either `start` or `end` is omitted, the range is unbounded in that direction. - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value. So `2024--` is equivalent to `2024-01-01--`. - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value. So `--2024` is equivalent to `--2024-12-31`. - Whitespace is allowed either side of `--`." }, { "kind": "field", "name": "allowDays", "type": { "text": "string" }, "default": "\"\"", "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`. A comma-separated list of days. Whitespace is allowed after commas. The default `''` has no effect on the result of `allow` and `disallow`. Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`." }, { "kind": "field", "name": "disallowDays", "type": { "text": "string" }, "default": "\"\"", "description": "Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`. A comma-separated list of days. Whitespace is allowed after commas. The default `''` has no effect on `allowDays`. Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`." } ], "events": [ { "name": "viewchange", "type": { "text": "CustomEvent" } }, { "name": "focus", "type": { "text": "CustomEvent" } }, { "name": "blur", "type": { "text": "CustomEvent" } }, { "name": "input", "type": { "text": "CustomEvent" } }, { "name": "change", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "type", "fieldName": "type", "type": { "text": "\"single\" | \"range\"" } }, { "name": "view", "fieldName": "view", "type": { "text": "string" }, "description": "Displayed month in `YYYY-MM` format. `onViewChange` is called when this value changes. Defaults to `defaultView`." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "default": "\"\"", "description": "Current selected value. The default means no date is selected. If the provided value is invalid, no date is selected. Otherwise: - If `type=\"single\"`, this is a date in `YYYY-MM-DD` format. - If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format. - If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive." }, { "name": "value", "fieldName": "defaultValue", "type": { "text": "string" }, "default": "\"\"", "description": "Default selected value. The default means no date is selected. If the provided value is invalid, no date is selected. - If `type=\"single\"`, this is a date in `YYYY-MM-DD` format. - If `type=\"multiple\"`, this is a comma-separated list of dates in `YYYY-MM-DD` format. - If `type=\"range\"`, this is a range in `YYYY-MM-DD--YYYY-MM-DD` format. The range is inclusive." }, { "name": "view", "fieldName": "defaultView", "type": { "text": "string" }, "description": "Default month to display in `YYYY-MM` format. This value is used until `view` is set, either directly or as a result of user interaction. Defaults to the current month in the user's locale." }, { "name": "allow", "fieldName": "allow", "type": { "text": "string" }, "default": "\"\"", "description": "Dates that can be selected. A comma-separated list of dates, date ranges. Whitespace is allowed after commas. The default `''` allows all dates. - Dates in `YYYY-MM-DD` format allow a single date. - Dates in `YYYY-MM` format allow a whole month. - Dates in `YYYY` format allow a whole year. - Ranges are expressed as `start--end`. - Ranges are inclusive. - If either `start` or `end` is omitted, the range is unbounded in that direction. - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value. So `2024--` is equivalent to `2024-01-01--`. - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value. So `--2024` is equivalent to `--2024-12-31`. - Whitespace is allowed either side of `--`." }, { "name": "disallow", "fieldName": "disallow", "type": { "text": "string" }, "default": "\"\"", "description": "Dates that cannot be selected. These subtract from `allow`. A comma-separated list of dates, date ranges. Whitespace is allowed after commas. The default `''` has no effect on `allow`. - Dates in `YYYY-MM-DD` format disallow a single date. - Dates in `YYYY-MM` format disallow a whole month. - Dates in `YYYY` format disallow a whole year. - Ranges are expressed as `start--end`. - Ranges are inclusive. - If either `start` or `end` is omitted, the range is unbounded in that direction. - If parts of the date are omitted for `start`, they are assumed to be the minimum possible value. So `2024--` is equivalent to `2024-01-01--`. - If parts of the date are omitted for `end`, they are assumed to be the maximum possible value. So `--2024` is equivalent to `--2024-12-31`. - Whitespace is allowed either side of `--`." }, { "name": "allowdays", "fieldName": "allowDays", "type": { "text": "string" }, "default": "\"\"", "description": "Days of the week that can be selected. These intersect with the result of `allow` and `disallow`. A comma-separated list of days. Whitespace is allowed after commas. The default `''` has no effect on the result of `allow` and `disallow`. Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`." }, { "name": "disallowdays", "fieldName": "disallowDays", "type": { "text": "string" }, "default": "\"\"", "description": "Days of the week that cannot be selected. This subtracts from `allowDays`, and intersects with the result of `allow` and `disallow`. A comma-separated list of days. Whitespace is allowed after commas. The default `''` has no effect on `allowDays`. Days are `sunday`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`." } ], "superclass": { "name": "DatePickerBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/DatePicker/DatePickerBase" }, "customElement": true, "tagName": "s-date-picker" } ] }, { "kind": "javascript-module", "path": "dist/components/Divider/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Divider", "members": [ { "kind": "field", "name": "direction", "type": { "text": "\"block\" | \"inline\"" }, "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values)." }, { "kind": "field", "name": "color", "type": { "text": "\"base\" | \"strong\"" }, "description": "Modify the color to be more or less intense." } ], "attributes": [ { "name": "direction", "fieldName": "direction", "type": { "text": "\"block\" | \"inline\"" }, "description": "Specify the direction of the divider. This uses [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values)." }, { "name": "color", "fieldName": "color", "type": { "text": "\"base\" | \"strong\"" }, "description": "Modify the color to be more or less intense." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-divider" } ] }, { "kind": "javascript-module", "path": "dist/components/DropZone/index.js", "declarations": [ { "kind": "class", "description": "", "name": "DropZone", "slots": [ { "name": "", "description": "Content to display inside the drop zone, such as upload instructions, file type icons, or previews of selected files. When provided, replaces the default upload prompt." } ], "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the item. When set, it will be announced to buyers using assistive technologies and will provide them with more context." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "default": "''", "description": "A string that represents the path to the selected file(s). If no file is selected yet, the value is an empty string (\"\"). When the user selected multiple files, the value represents the first file in the list of files they selected. The value is always the file's name prefixed with \"C:\\fakepath\\\", which isn't the real path of the file." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Whether multiple files can be selected or dropped at once." }, { "kind": "field", "name": "accept", "type": { "text": "string" }, "default": "''", "description": "A string representing the types of files that are accepted by the drop zone. This string is a comma-separated list of unique file type specifiers which can be one of the following: - A file extension starting with a period (\".\") character (e.g. .jpg, .pdf, .doc) - A valid MIME type string with no extensions If omitted, all file types are accepted." }, { "kind": "field", "name": "files", "type": { "text": "readonly File[]" }, "default": "[]", "description": "An array of File objects representing the files currently selected by the user. This property is read-only and cannot be directly modified. To clear the selected files, set the `value` prop to an empty string or null." } ], "events": [ { "name": "change", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user selects files through the file picker or drops valid files onto the drop zone. Access the selected files through `event.currentTarget.files`. Use to process uploads, generate previews, or validate file contents." }, { "name": "input", "type": { "text": "CustomEvent" }, "description": "A callback fired when files are selected or dropped. Similar to `onChange` but may fire more frequently during drag operations. Use when you need immediate feedback as files are being dragged over the drop zone." }, { "name": "droprejected", "type": { "text": "CustomEvent" }, "description": "A callback fired when dropped or selected files don't match the `accept` criteria. Use to display error messages explaining which file types are allowed. Rejected files are not added to the `files` array." } ], "attributes": [ { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the item. When set, it will be announced to buyers using assistive technologies and will provide them with more context." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "default": "''", "description": "A string that represents the path to the selected file(s). If no file is selected yet, the value is an empty string (\"\"). When the user selected multiple files, the value represents the first file in the list of files they selected. The value is always the file's name prefixed with \"C:\\fakepath\\\", which isn't the real path of the file." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "multiple", "fieldName": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Whether multiple files can be selected or dropped at once." }, { "name": "accept", "fieldName": "accept", "type": { "text": "string" }, "default": "''", "description": "A string representing the types of files that are accepted by the drop zone. This string is a comma-separated list of unique file type specifiers which can be one of the following: - A file extension starting with a period (\".\") character (e.g. .jpg, .pdf, .doc) - A valid MIME type string with no extensions If omitted, all file types are accepted." }, { "name": "files", "fieldName": "files", "type": { "text": "readonly File[]" }, "default": "[]", "description": "An array of File objects representing the files currently selected by the user. This property is read-only and cannot be directly modified. To clear the selected files, set the `value` prop to an empty string or null." } ], "superclass": { "name": "DropZoneBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/DropZone/DropZoneBase" }, "customElement": true, "tagName": "s-drop-zone" } ] }, { "kind": "javascript-module", "path": "dist/components/EmailField/index.js", "declarations": [ { "kind": "class", "description": "", "name": "EmailField", "slots": [ { "name": "error" }, { "name": "details" } ], "members": [ { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "autocomplete", "type": { "text": "\"email\" | \"home email\" | \"mobile email\" | \"fax email\" | \"pager email\" | \"on\" | \"off\" | \"shipping email\" | \"shipping home email\" | \"shipping mobile email\" | \"shipping fax email\" | \"shipping pager email\" | \"billing email\" | \"billing home email\" | \"billing mobile email\" | \"billing fax email\" | \"billing pager email\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "default": "Infinity", "description": "Specifies the maximum number of characters allowed." }, { "kind": "field", "name": "minLength", "type": { "text": "number" }, "default": "0", "description": "Specifies the min number of characters allowed." } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user makes changes to the field value. This fires before `onChange`." }, { "name": "change", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user has finished editing the field, such as when they blur the field." }, { "name": "focus", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field receives focus." }, { "name": "blur", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field loses focus." } ], "attributes": [ { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "name": "value", "fieldName": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "\"email\" | \"home email\" | \"mobile email\" | \"fax email\" | \"pager email\" | \"on\" | \"off\" | \"shipping email\" | \"shipping home email\" | \"shipping mobile email\" | \"shipping fax email\" | \"shipping pager email\" | \"billing email\" | \"billing home email\" | \"billing mobile email\" | \"billing fax email\" | \"billing pager email\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "default": "Infinity", "description": "Specifies the maximum number of characters allowed." }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "default": "0", "description": "Specifies the min number of characters allowed." } ], "superclass": { "name": "EmailFieldBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/EmailField/EmailFieldBase" }, "customElement": true, "tagName": "s-email-field" } ] }, { "kind": "javascript-module", "path": "dist/components/Grid/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Grid", "slots": [ { "name": "", "description": "The content of the Grid." } ], "members": [ { "kind": "field", "name": "alignItems", "type": { "text": "\"normal\" | \"stretch\" | \"baseline\" | \"first baseline\" | \"last baseline\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\"" }, "default": "'' - meaning no override", "description": "Aligns the grid items along the block axis." }, { "kind": "field", "name": "justifyItems", "type": { "text": "\"normal\" | \"stretch\" | \"baseline\" | \"first baseline\" | \"last baseline\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\"" }, "default": "'' - meaning no override", "description": "Aligns the grid items along the inline axis." }, { "kind": "field", "name": "placeItems", "type": { "text": "AlignItemsKeyword | \"normal normal\" | \"normal stretch\" | \"normal baseline\" | \"normal first baseline\" | \"normal last baseline\" | \"normal center\" | \"normal start\" | ... 188 more ... | \"safe end safe end\"" }, "default": "'normal normal'", "description": "A shorthand property for `justify-items` and `align-items`." }, { "kind": "field", "name": "alignContent", "type": { "text": "\"normal\" | \"stretch\" | \"baseline\" | \"first baseline\" | \"last baseline\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\" | \"space-between\" | \"space-around\" | \"space-evenly\"" }, "default": "'' - meaning no override", "description": "Aligns the grid along the block axis. This overrides the block value of `placeContent`." }, { "kind": "field", "name": "justifyContent", "type": { "text": "\"normal\" | \"stretch\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\" | \"space-between\" | \"space-around\" | \"space-evenly\"" }, "default": "'' - meaning no override", "description": "Aligns the grid along the inline axis. This overrides the inline value of `placeContent`." }, { "kind": "field", "name": "placeContent", "type": { "text": "\"normal normal\" | \"normal stretch\" | \"normal center\" | \"normal start\" | \"normal end\" | \"normal unsafe center\" | \"normal unsafe start\" | \"normal unsafe end\" | \"normal safe center\" | ... 229 more ... | \"space-evenly space-evenly\"" }, "default": "'normal normal'", "description": "A shorthand property for `justify-content` and `align-content`." }, { "kind": "field", "name": "gap", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust spacing between elements. `gap` can either accept: - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value applied to both axes (e.g. `large-100`) - OR a pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "kind": "field", "name": "rowGap", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust spacing between elements in the block axis. This overrides the row value of `gap`. `rowGap` either accepts: - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value (e.g. `large-100`) - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "kind": "field", "name": "columnGap", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust spacing between elements in the inline axis. This overrides the column value of `gap`. `columnGap` either accepts: - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value (e.g. `large-100`) - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "kind": "field", "name": "gridTemplateColumns", "type": { "text": "string" }, "default": "'none'", "description": "Define columns and specify their size. `gridTemplateColumns` either accepts: - [track sizing values](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Basic_concepts_of_grid_layout#fixed_and_flexible_track_sizes) (e.g. `1fr auto`) - OR [responsive values](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported track sizing values as a query value." }, { "kind": "field", "name": "gridTemplateRows", "type": { "text": "string" }, "default": "'none'", "description": "Define rows and specify their size. `gridTemplateRows` either accepts: - [track sizing values](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Basic_concepts_of_grid_layout#fixed_and_flexible_track_sizes) (e.g. `1fr auto`) - OR [responsive values](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported track sizing values as a query value." }, { "kind": "field", "name": "background", "type": { "text": "\"subdued\" | \"base\" | \"strong\" | \"transparent\"" }, "default": "'transparent'", "description": "Adjust the background of the component." }, { "kind": "field", "name": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." }, { "kind": "field", "name": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "kind": "field", "name": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "kind": "field", "name": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "kind": "field", "name": "padding", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust the padding of all edges. [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is: - 4 values: `block-start inline-end block-end inline-start` - 3 values: `block-start inline block-end` - 2 values: `block inline` For example: - `large` means block-start, inline-end, block-end and inline-start paddings are `large`. - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`. - `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`. - `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`. A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. `padding` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlock", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the block-padding. - `large none` means block-start padding is `large`, block-end padding is `none`. This overrides the block value of `padding`. `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlockStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-start padding. This overrides the block-start value of `paddingBlock`. `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlockEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-end padding. This overrides the block-end value of `paddingBlock`. `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInline", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the inline padding. - `large none` means inline-start padding is `large`, inline-end padding is `none`. This overrides the inline value of `padding`. `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInlineStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-start padding. This overrides the inline-start value of `paddingInline`. `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInlineEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-end padding. This overrides the inline-end value of `paddingInline`. `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "display", "type": { "text": "\"auto\" | \"none\"" }, "default": "'auto'", "description": "Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers." }, { "kind": "field", "name": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size)." }, { "kind": "field", "name": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size)." }, { "kind": "field", "name": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size)." }, { "kind": "field", "name": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size)." }, { "kind": "field", "name": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size)." }, { "kind": "field", "name": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size)." }, { "kind": "field", "name": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context. Only use this when the element's content is not enough context for users using assistive technologies." }, { "kind": "field", "name": "accessibilityRole", "type": { "text": "\"generic\" | \"status\" | \"main\" | \"header\" | \"footer\" | \"section\" | \"region\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"alert\" | \"presentation\" | \"none\"" }, "default": "'generic'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page." }, { "kind": "field", "name": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "kind": "field", "name": "overflow", "type": { "text": "\"visible\" | \"hidden\"" }, "default": "'visible'", "description": "Sets the overflow behavior of the element. - `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse. - `visible`: the content that extends beyond the element’s container is visible." } ], "attributes": [ { "name": "alignitems", "fieldName": "alignItems", "type": { "text": "\"normal\" | \"stretch\" | \"baseline\" | \"first baseline\" | \"last baseline\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\"" }, "default": "'' - meaning no override", "description": "Aligns the grid items along the block axis." }, { "name": "justifyitems", "fieldName": "justifyItems", "type": { "text": "\"normal\" | \"stretch\" | \"baseline\" | \"first baseline\" | \"last baseline\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\"" }, "default": "'' - meaning no override", "description": "Aligns the grid items along the inline axis." }, { "name": "placeitems", "fieldName": "placeItems", "type": { "text": "AlignItemsKeyword | \"normal normal\" | \"normal stretch\" | \"normal baseline\" | \"normal first baseline\" | \"normal last baseline\" | \"normal center\" | \"normal start\" | ... 188 more ... | \"safe end safe end\"" }, "default": "'normal normal'", "description": "A shorthand property for `justify-items` and `align-items`." }, { "name": "aligncontent", "fieldName": "alignContent", "type": { "text": "\"normal\" | \"stretch\" | \"baseline\" | \"first baseline\" | \"last baseline\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\" | \"space-between\" | \"space-around\" | \"space-evenly\"" }, "default": "'' - meaning no override", "description": "Aligns the grid along the block axis. This overrides the block value of `placeContent`." }, { "name": "justifycontent", "fieldName": "justifyContent", "type": { "text": "\"normal\" | \"stretch\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\" | \"space-between\" | \"space-around\" | \"space-evenly\"" }, "default": "'' - meaning no override", "description": "Aligns the grid along the inline axis. This overrides the inline value of `placeContent`." }, { "name": "placecontent", "fieldName": "placeContent", "type": { "text": "\"normal normal\" | \"normal stretch\" | \"normal center\" | \"normal start\" | \"normal end\" | \"normal unsafe center\" | \"normal unsafe start\" | \"normal unsafe end\" | \"normal safe center\" | ... 229 more ... | \"space-evenly space-evenly\"" }, "default": "'normal normal'", "description": "A shorthand property for `justify-content` and `align-content`." }, { "name": "gap", "fieldName": "gap", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust spacing between elements. `gap` can either accept: - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value applied to both axes (e.g. `large-100`) - OR a pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "name": "rowgap", "fieldName": "rowGap", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust spacing between elements in the block axis. This overrides the row value of `gap`. `rowGap` either accepts: - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value (e.g. `large-100`) - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "name": "columngap", "fieldName": "columnGap", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust spacing between elements in the inline axis. This overrides the column value of `gap`. `columnGap` either accepts: - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value (e.g. `large-100`) - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "name": "gridtemplatecolumns", "fieldName": "gridTemplateColumns", "type": { "text": "string" }, "default": "'none'", "description": "Define columns and specify their size. `gridTemplateColumns` either accepts: - [track sizing values](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Basic_concepts_of_grid_layout#fixed_and_flexible_track_sizes) (e.g. `1fr auto`) - OR [responsive values](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported track sizing values as a query value." }, { "name": "gridtemplaterows", "fieldName": "gridTemplateRows", "type": { "text": "string" }, "default": "'none'", "description": "Define rows and specify their size. `gridTemplateRows` either accepts: - [track sizing values](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout/Basic_concepts_of_grid_layout#fixed_and_flexible_track_sizes) (e.g. `1fr auto`) - OR [responsive values](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported track sizing values as a query value." }, { "name": "background", "fieldName": "background", "type": { "text": "\"subdued\" | \"base\" | \"strong\" | \"transparent\"" }, "default": "'transparent'", "description": "Adjust the background of the component." }, { "name": "borderwidth", "fieldName": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." }, { "name": "borderstyle", "fieldName": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "name": "bordercolor", "fieldName": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "name": "borderradius", "fieldName": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "name": "padding", "fieldName": "padding", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust the padding of all edges. [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is: - 4 values: `block-start inline-end block-end inline-start` - 3 values: `block-start inline block-end` - 2 values: `block inline` For example: - `large` means block-start, inline-end, block-end and inline-start paddings are `large`. - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`. - `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`. - `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`. A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. `padding` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblock", "fieldName": "paddingBlock", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the block-padding. - `large none` means block-start padding is `large`, block-end padding is `none`. This overrides the block value of `padding`. `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblockstart", "fieldName": "paddingBlockStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-start padding. This overrides the block-start value of `paddingBlock`. `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblockend", "fieldName": "paddingBlockEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-end padding. This overrides the block-end value of `paddingBlock`. `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginline", "fieldName": "paddingInline", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the inline padding. - `large none` means inline-start padding is `large`, inline-end padding is `none`. This overrides the inline value of `padding`. `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginlinestart", "fieldName": "paddingInlineStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-start padding. This overrides the inline-start value of `paddingInline`. `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginlineend", "fieldName": "paddingInlineEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-end padding. This overrides the inline-end value of `paddingInline`. `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "display", "fieldName": "display", "type": { "text": "\"auto\" | \"none\"" }, "default": "'auto'", "description": "Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers." }, { "name": "blocksize", "fieldName": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size)." }, { "name": "minblocksize", "fieldName": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size)." }, { "name": "maxblocksize", "fieldName": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size)." }, { "name": "inlinesize", "fieldName": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size)." }, { "name": "mininlinesize", "fieldName": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size)." }, { "name": "maxinlinesize", "fieldName": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size)." }, { "name": "accessibilityvisibility", "fieldName": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context. Only use this when the element's content is not enough context for users using assistive technologies." }, { "name": "accessibilityrole", "fieldName": "accessibilityRole", "type": { "text": "\"generic\" | \"status\" | \"main\" | \"header\" | \"footer\" | \"section\" | \"region\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"alert\" | \"presentation\" | \"none\"" }, "default": "'generic'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page." }, { "name": "border", "fieldName": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "name": "overflow", "fieldName": "overflow", "type": { "text": "\"visible\" | \"hidden\"" }, "default": "'visible'", "description": "Sets the overflow behavior of the element. - `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse. - `visible`: the content that extends beyond the element’s container is visible." } ], "superclass": { "name": "BoxElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/BoxElement" }, "customElement": true, "tagName": "s-grid" } ] }, { "kind": "javascript-module", "path": "dist/components/GridItem/index.js", "declarations": [ { "kind": "class", "description": "", "name": "GridItem", "slots": [ { "name": "", "description": "The content of the GridItem." } ], "members": [ { "kind": "field", "name": "gridColumn", "type": { "text": "\"auto\"" }, "description": "Number of columns the item will span across" }, { "kind": "field", "name": "gridRow", "type": { "text": "\"auto\"" }, "description": "Number of rows the item will span across" }, { "kind": "field", "name": "background", "type": { "text": "\"subdued\" | \"base\" | \"strong\" | \"transparent\"" }, "default": "'transparent'", "description": "Adjust the background of the component." }, { "kind": "field", "name": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." }, { "kind": "field", "name": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "kind": "field", "name": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "kind": "field", "name": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "kind": "field", "name": "padding", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust the padding of all edges. [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is: - 4 values: `block-start inline-end block-end inline-start` - 3 values: `block-start inline block-end` - 2 values: `block inline` For example: - `large` means block-start, inline-end, block-end and inline-start paddings are `large`. - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`. - `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`. - `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`. A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. `padding` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlock", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the block-padding. - `large none` means block-start padding is `large`, block-end padding is `none`. This overrides the block value of `padding`. `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlockStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-start padding. This overrides the block-start value of `paddingBlock`. `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlockEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-end padding. This overrides the block-end value of `paddingBlock`. `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInline", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the inline padding. - `large none` means inline-start padding is `large`, inline-end padding is `none`. This overrides the inline value of `padding`. `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInlineStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-start padding. This overrides the inline-start value of `paddingInline`. `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInlineEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-end padding. This overrides the inline-end value of `paddingInline`. `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "display", "type": { "text": "\"auto\" | \"none\"" }, "default": "'auto'", "description": "Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers." }, { "kind": "field", "name": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size)." }, { "kind": "field", "name": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size)." }, { "kind": "field", "name": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size)." }, { "kind": "field", "name": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size)." }, { "kind": "field", "name": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size)." }, { "kind": "field", "name": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size)." }, { "kind": "field", "name": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context. Only use this when the element's content is not enough context for users using assistive technologies." }, { "kind": "field", "name": "accessibilityRole", "type": { "text": "\"generic\" | \"status\" | \"main\" | \"header\" | \"footer\" | \"section\" | \"region\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"alert\" | \"presentation\" | \"none\"" }, "default": "'generic'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page." }, { "kind": "field", "name": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "kind": "field", "name": "overflow", "type": { "text": "\"visible\" | \"hidden\"" }, "default": "'visible'", "description": "Sets the overflow behavior of the element. - `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse. - `visible`: the content that extends beyond the element’s container is visible." } ], "attributes": [ { "name": "gridcolumn", "fieldName": "gridColumn", "type": { "text": "\"auto\"" }, "description": "Number of columns the item will span across" }, { "name": "gridrow", "fieldName": "gridRow", "type": { "text": "\"auto\"" }, "description": "Number of rows the item will span across" }, { "name": "background", "fieldName": "background", "type": { "text": "\"subdued\" | \"base\" | \"strong\" | \"transparent\"" }, "default": "'transparent'", "description": "Adjust the background of the component." }, { "name": "borderwidth", "fieldName": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." }, { "name": "borderstyle", "fieldName": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "name": "bordercolor", "fieldName": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "name": "borderradius", "fieldName": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "name": "padding", "fieldName": "padding", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust the padding of all edges. [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is: - 4 values: `block-start inline-end block-end inline-start` - 3 values: `block-start inline block-end` - 2 values: `block inline` For example: - `large` means block-start, inline-end, block-end and inline-start paddings are `large`. - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`. - `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`. - `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`. A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. `padding` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblock", "fieldName": "paddingBlock", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the block-padding. - `large none` means block-start padding is `large`, block-end padding is `none`. This overrides the block value of `padding`. `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblockstart", "fieldName": "paddingBlockStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-start padding. This overrides the block-start value of `paddingBlock`. `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblockend", "fieldName": "paddingBlockEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-end padding. This overrides the block-end value of `paddingBlock`. `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginline", "fieldName": "paddingInline", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the inline padding. - `large none` means inline-start padding is `large`, inline-end padding is `none`. This overrides the inline value of `padding`. `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginlinestart", "fieldName": "paddingInlineStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-start padding. This overrides the inline-start value of `paddingInline`. `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginlineend", "fieldName": "paddingInlineEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-end padding. This overrides the inline-end value of `paddingInline`. `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "display", "fieldName": "display", "type": { "text": "\"auto\" | \"none\"" }, "default": "'auto'", "description": "Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers." }, { "name": "blocksize", "fieldName": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size)." }, { "name": "minblocksize", "fieldName": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size)." }, { "name": "maxblocksize", "fieldName": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size)." }, { "name": "inlinesize", "fieldName": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size)." }, { "name": "mininlinesize", "fieldName": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size)." }, { "name": "maxinlinesize", "fieldName": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size)." }, { "name": "accessibilityvisibility", "fieldName": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context. Only use this when the element's content is not enough context for users using assistive technologies." }, { "name": "accessibilityrole", "fieldName": "accessibilityRole", "type": { "text": "\"generic\" | \"status\" | \"main\" | \"header\" | \"footer\" | \"section\" | \"region\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"alert\" | \"presentation\" | \"none\"" }, "default": "'generic'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page." }, { "name": "border", "fieldName": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "name": "overflow", "fieldName": "overflow", "type": { "text": "\"visible\" | \"hidden\"" }, "default": "'visible'", "description": "Sets the overflow behavior of the element. - `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse. - `visible`: the content that extends beyond the element’s container is visible." } ], "superclass": { "name": "BoxElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/BoxElement" }, "customElement": true, "tagName": "s-grid-item" } ] }, { "kind": "javascript-module", "path": "dist/components/Heading/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Heading", "slots": [ { "name": "", "description": "The content of the Heading." } ], "members": [ { "kind": "field", "name": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "lineClamp", "type": { "text": "number" }, "default": "Infinity - no truncation is applied", "description": "Truncates the text content to the specified number of lines." }, { "kind": "field", "name": "accessibilityRole", "type": { "text": "\"heading\" | \"presentation\" | \"none\"" }, "default": "'heading'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page. - `heading`: defines the element as a heading to a page or section. - `presentation`: the heading level will be stripped, and will prevent the element’s implicit ARIA semantics from being exposed to the accessibility tree. - `none`: a synonym for the `presentation` role." } ], "attributes": [ { "name": "accessibilityvisibility", "fieldName": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "name": "lineclamp", "fieldName": "lineClamp", "type": { "text": "number" }, "default": "Infinity - no truncation is applied", "description": "Truncates the text content to the specified number of lines." }, { "name": "accessibilityrole", "fieldName": "accessibilityRole", "type": { "text": "\"heading\" | \"presentation\" | \"none\"" }, "default": "'heading'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page. - `heading`: defines the element as a heading to a page or section. - `presentation`: the heading level will be stripped, and will prevent the element’s implicit ARIA semantics from being exposed to the accessibility tree. - `none`: a synonym for the `presentation` role." } ], "superclass": { "name": "HeadingBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Heading/HeadingBase" }, "customElement": true, "tagName": "s-heading" } ] }, { "kind": "javascript-module", "path": "dist/components/Icon/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Icon", "members": [ { "kind": "field", "name": "type", "type": { "text": "\"color\" | \"info\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"channels-filled\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\"" }, "description": "Specifies the type of icon that will be displayed." }, { "kind": "field", "name": "tone", "type": { "text": "\"auto\" | \"neutral\" | \"info\" | \"success\" | \"caution\" | \"warning\" | \"critical\"" }, "description": "Sets the tone of the icon, based on the intention of the information being conveyed." }, { "kind": "field", "name": "color", "type": { "text": "\"subdued\" | \"base\"" }, "description": "Modify the color to be more or less intense." }, { "kind": "field", "name": "size", "type": { "text": "\"base\" | \"small\"" }, "description": "Adjusts the size of the icon." }, { "kind": "field", "name": "interestFor", "type": { "text": "string" }, "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component." } ], "attributes": [ { "name": "type", "fieldName": "type", "type": { "text": "\"color\" | \"info\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"channels-filled\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\"" }, "description": "Specifies the type of icon that will be displayed." }, { "name": "tone", "fieldName": "tone", "type": { "text": "\"auto\" | \"neutral\" | \"info\" | \"success\" | \"caution\" | \"warning\" | \"critical\"" }, "description": "Sets the tone of the icon, based on the intention of the information being conveyed." }, { "name": "color", "fieldName": "color", "type": { "text": "\"subdued\" | \"base\"" }, "description": "Modify the color to be more or less intense." }, { "name": "size", "fieldName": "size", "type": { "text": "\"base\" | \"small\"" }, "description": "Adjusts the size of the icon." }, { "name": "interestfor", "fieldName": "interestFor", "type": { "text": "string" }, "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component." } ], "superclass": { "name": "IconBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Icon/IconBase" }, "customElement": true, "tagName": "s-icon" } ] }, { "kind": "javascript-module", "path": "dist/components/Image/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Image", "members": [ { "kind": "field", "name": "accessibilityRole", "type": { "text": "\"presentation\" | \"none\" | \"img\"" }, "default": "'img'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page." }, { "kind": "field", "name": "inlineSize", "type": { "text": "\"auto\" | \"fill\"" }, "default": "'fill'", "description": "The displayed inline width of the image. - `fill`: the image will takes up 100% of the available inline size. - `auto`: the image will be displayed at its natural size." }, { "kind": "field", "name": "loading", "type": { "text": "\"eager\" | \"lazy\"" }, "default": "'eager'", "description": "Determines the loading behavior of the image: - `eager`: Immediately loads the image, irrespective of its position within the visible viewport. - `lazy`: Delays loading the image until it approaches a specified distance from the viewport." }, { "kind": "field", "name": "alt", "type": { "text": "string" }, "default": "`''`", "description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more." }, { "kind": "field", "name": "src", "type": { "text": "string" }, "description": "The image source (either a remote URL or a local file resource). When the image is loading or no `src` is provided, a placeholder will be rendered." }, { "kind": "field", "name": "srcSet", "type": { "text": "string" }, "description": "A set of image sources and their width or pixel density descriptors. This overrides the `src` property." }, { "kind": "field", "name": "sizes", "type": { "text": "string" }, "description": "A set of media conditions and their corresponding sizes." }, { "kind": "field", "name": "aspectRatio", "type": { "text": "`${number}` | `${number}/${number}` | `${number}/ ${number}` | `${number} /${number}` | `${number} / ${number}`" }, "default": "'1/1'", "description": "The aspect ratio of the image. The rendering of the image will depend on the `inlineSize` value: - `inlineSize=\"fill\"`: the aspect ratio will be respected and the image will take the necessary space. - `inlineSize=\"auto\"`: the image will not render until it has loaded and the aspect ratio will be ignored. For example, if the value is set as `50 / 100`, the getter returns `50 / 100`. If the value is set as `0.5`, the getter returns `0.5 / 1`." }, { "kind": "field", "name": "objectFit", "type": { "text": "\"contain\" | \"cover\"" }, "default": "'contain'", "description": "Determines how the content of the image is resized to fit its container. The image is positioned in the center of the container." }, { "kind": "field", "name": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "kind": "field", "name": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "kind": "field", "name": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "kind": "field", "name": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "kind": "field", "name": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." } ], "events": [ { "name": "error", "type": { "text": "CustomEvent" } }, { "name": "load", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "accessibilityrole", "fieldName": "accessibilityRole", "type": { "text": "\"presentation\" | \"none\" | \"img\"" }, "default": "'img'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page." }, { "name": "inlinesize", "fieldName": "inlineSize", "type": { "text": "\"auto\" | \"fill\"" }, "default": "'fill'", "description": "The displayed inline width of the image. - `fill`: the image will takes up 100% of the available inline size. - `auto`: the image will be displayed at its natural size." }, { "name": "loading", "fieldName": "loading", "type": { "text": "\"eager\" | \"lazy\"" }, "default": "'eager'", "description": "Determines the loading behavior of the image: - `eager`: Immediately loads the image, irrespective of its position within the visible viewport. - `lazy`: Delays loading the image until it approaches a specified distance from the viewport." }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "default": "`''`", "description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more." }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "description": "The image source (either a remote URL or a local file resource). When the image is loading or no `src` is provided, a placeholder will be rendered." }, { "name": "srcset", "fieldName": "srcSet", "type": { "text": "string" }, "description": "A set of image sources and their width or pixel density descriptors. This overrides the `src` property." }, { "name": "sizes", "fieldName": "sizes", "type": { "text": "string" }, "description": "A set of media conditions and their corresponding sizes." }, { "name": "aspectratio", "fieldName": "aspectRatio", "type": { "text": "`${number}` | `${number}/${number}` | `${number}/ ${number}` | `${number} /${number}` | `${number} / ${number}`" }, "default": "'1/1'", "description": "The aspect ratio of the image. The rendering of the image will depend on the `inlineSize` value: - `inlineSize=\"fill\"`: the aspect ratio will be respected and the image will take the necessary space. - `inlineSize=\"auto\"`: the image will not render until it has loaded and the aspect ratio will be ignored. For example, if the value is set as `50 / 100`, the getter returns `50 / 100`. If the value is set as `0.5`, the getter returns `0.5 / 1`." }, { "name": "objectfit", "fieldName": "objectFit", "type": { "text": "\"contain\" | \"cover\"" }, "default": "'contain'", "description": "Determines how the content of the image is resized to fit its container. The image is positioned in the center of the container." }, { "name": "border", "fieldName": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "name": "bordercolor", "fieldName": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "name": "borderradius", "fieldName": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "name": "borderstyle", "fieldName": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "name": "borderwidth", "fieldName": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-image" } ] }, { "kind": "javascript-module", "path": "dist/components/Link/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Link", "slots": [ { "name": "", "description": "The content of the Link." } ], "members": [ { "kind": "field", "name": "tone", "type": { "text": "\"auto\" | \"neutral\" | \"critical\"" }, "description": "Sets the tone of the Link, based on the intention of the information being conveyed." }, { "kind": "field", "name": "interestFor", "type": { "text": "string" }, "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component." }, { "kind": "field", "name": "download", "type": { "text": "string" }, "description": "Causes the browser to treat the linked URL as a download with the string being the file name. Download only works for same-origin URLs or the `blob:` and `data:` schemes." }, { "kind": "field", "name": "target", "type": { "text": "\"auto\" | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"" }, "default": "'auto'", "description": "Specifies where to display the linked URL." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the Link. It will be read to users using assistive technologies such as screen readers. Use this when using only an icon or the content of the link is not enough context for users using assistive technologies." }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)" }, { "kind": "field", "name": "command", "type": { "text": "\"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\"" }, "default": "'--auto'", "description": "Sets the action the `commandFor` should take when this clickable is activated. See the documentation of particular components for the actions they support. - `--auto`: a default action for the target component. - `--show`: shows the target component. - `--hide`: hides the target component. - `--toggle`: toggles the target component. - `--copy`: copies the target ClipboardItem." }, { "kind": "field", "name": "commandFor", "type": { "text": "string" }, "description": "ID of a component that should respond to activations (e.g. clicks) on this component. See `command` for how to control the behavior of the target." }, { "kind": "field", "name": "href", "type": { "text": "string" }, "description": "The URL to link to. - If set, it will navigate to the location specified by `href` after executing the `click` event. - If a `commandFor` is set, the `command` will be executed instead of the navigation." } ], "events": [ { "name": "click", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "tone", "fieldName": "tone", "type": { "text": "\"auto\" | \"neutral\" | \"critical\"" }, "description": "Sets the tone of the Link, based on the intention of the information being conveyed." }, { "name": "interestfor", "fieldName": "interestFor", "type": { "text": "string" }, "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component." }, { "name": "download", "fieldName": "download", "type": { "text": "string" }, "description": "Causes the browser to treat the linked URL as a download with the string being the file name. Download only works for same-origin URLs or the `blob:` and `data:` schemes." }, { "name": "target", "fieldName": "target", "type": { "text": "\"auto\" | \"_blank\" | \"_self\" | \"_parent\" | \"_top\"" }, "default": "'auto'", "description": "Specifies where to display the linked URL." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the Link. It will be read to users using assistive technologies such as screen readers. Use this when using only an icon or the content of the link is not enough context for users using assistive technologies." }, { "name": "lang", "fieldName": "lang", "type": { "text": "string" }, "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)" }, { "name": "command", "fieldName": "command", "type": { "text": "\"--auto\" | \"--show\" | \"--hide\" | \"--toggle\" | \"--copy\"" }, "default": "'--auto'", "description": "Sets the action the `commandFor` should take when this clickable is activated. See the documentation of particular components for the actions they support. - `--auto`: a default action for the target component. - `--show`: shows the target component. - `--hide`: hides the target component. - `--toggle`: toggles the target component. - `--copy`: copies the target ClipboardItem." }, { "name": "commandfor", "fieldName": "commandFor", "type": { "text": "string" }, "description": "ID of a component that should respond to activations (e.g. clicks) on this component. See `command` for how to control the behavior of the target." }, { "name": "href", "fieldName": "href", "type": { "text": "string" }, "description": "The URL to link to. - If set, it will navigate to the location specified by `href` after executing the `click` event. - If a `commandFor` is set, the `command` will be executed instead of the navigation." } ], "superclass": { "name": "LinkBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Link/LinkBase" }, "customElement": true, "tagName": "s-link" } ] }, { "kind": "javascript-module", "path": "dist/components/ListItem/index.js", "declarations": [ { "kind": "class", "description": "", "name": "ListItem", "slots": [ { "name": "", "description": "The content of the ListItem." } ], "members": [ { "kind": "field", "name": "children", "type": { "text": "any" }, "description": "The content of the ListItem." }, { "kind": "field", "name": "id", "type": { "text": "string | undefined" }, "description": "A unique identifier for the element." } ], "attributes": [ { "name": "children", "fieldName": "children", "type": { "text": "any" }, "description": "The content of the ListItem." }, { "name": "id", "fieldName": "id", "type": { "text": "string | undefined" }, "description": "A unique identifier for the element." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-list-item" } ] }, { "kind": "javascript-module", "path": "dist/components/Menu/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Menu", "slots": [ { "name": "", "description": "The Menu items. Only accepts `Button` and `Section` components." } ], "members": [ { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the element. When set, it will be announced using assistive technologies and provide additional context." } ], "attributes": [ { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the element. When set, it will be announced using assistive technologies and provide additional context." } ], "superclass": { "name": "PreactOverlayElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PreactOverlayElement" }, "customElement": true, "tagName": "s-menu" } ] }, { "kind": "javascript-module", "path": "dist/components/Modal/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Modal", "slots": [ { "name": "", "description": "The content displayed within the modal, typically including form fields, informational text, or interactive elements that require focused user attention." }, { "name": "primary-action", "description": "The main action button displayed in the modal footer, representing the primary action users should take. Only accepts a button component with a `variant` of `primary`. This action should align with the modal's main purpose, such as \"Save\", \"Confirm\", or \"Submit\"." }, { "name": "secondary-actions", "description": "Additional action buttons displayed in the modal footer, providing alternative or supporting actions such as \"Cancel\" or \"Learn more\". Only accepts button components with a `variant` of `secondary` or `auto`. These are visually de-emphasized compared to the primary action to establish clear hierarchy." } ], "members": [ { "kind": "field", "name": "size", "type": { "text": "\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\"" }, "description": "Adjust the size of the Modal." }, { "kind": "field", "name": "alignSelf", "type": { "text": "\"center\" | \"start\"" }, "default": "'center'", "description": "Places the Modal on the block axis on a large screen" }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose of the modal. When set, it will be announced to users using assistive technologies and will provide them with more context. This overrides the `heading` prop for screen readers." }, { "kind": "field", "name": "heading", "type": { "text": "string" }, "description": "A title that describes the content of the Modal." }, { "kind": "field", "name": "padding", "type": { "text": "\"base\" | \"none\"" }, "default": "'base'", "description": "Adjust the padding around the Modal content. `base`: applies padding that is appropriate for the element. `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." }, { "kind": "field", "name": "hideOverlay", "type": { "text": "() => void" }, "description": "Method to hide an overlay." }, { "kind": "field", "name": "showOverlay", "type": { "text": "() => void" }, "description": "Method to show an overlay." }, { "kind": "field", "name": "toggleOverlay", "type": { "text": "() => void" }, "description": "Method to toggle the visiblity of an overlay." } ], "events": [ { "name": "hide", "type": { "text": "CustomEvent" }, "description": "A callback fired when the modal closes. Use to perform cleanup or trigger side effects when the modal is dismissed." }, { "name": "show", "type": { "text": "CustomEvent" }, "description": "A callback fired when the modal starts to open, before any entrance animation begins. Use to prepare content or fetch data needed for the modal." }, { "name": "afterhide", "type": { "text": "CustomEvent" }, "description": "A callback fired after the modal has fully closed and any exit animation completes. Use to reset form state, clear temporary data, or update the page after dismissal." }, { "name": "aftershow", "type": { "text": "CustomEvent" }, "description": "A callback fired after the modal has fully opened and any entrance animation completes. Use to focus an input field or initialize content once the modal is visible." } ], "attributes": [ { "name": "size", "fieldName": "size", "type": { "text": "\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\"" }, "description": "Adjust the size of the Modal." }, { "name": "alignself", "fieldName": "alignSelf", "type": { "text": "\"center\" | \"start\"" }, "default": "'center'", "description": "Places the Modal on the block axis on a large screen" }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose of the modal. When set, it will be announced to users using assistive technologies and will provide them with more context. This overrides the `heading` prop for screen readers." }, { "name": "heading", "fieldName": "heading", "type": { "text": "string" }, "description": "A title that describes the content of the Modal." }, { "name": "padding", "fieldName": "padding", "type": { "text": "\"base\" | \"none\"" }, "default": "'base'", "description": "Adjust the padding around the Modal content. `base`: applies padding that is appropriate for the element. `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." }, { "name": "hideoverlay", "fieldName": "hideOverlay", "type": { "text": "() => void" }, "description": "Method to hide an overlay." }, { "name": "showoverlay", "fieldName": "showOverlay", "type": { "text": "() => void" }, "description": "Method to show an overlay." }, { "name": "toggleoverlay", "fieldName": "toggleOverlay", "type": { "text": "() => void" }, "description": "Method to toggle the visiblity of an overlay." } ], "superclass": { "name": "ModalBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Modal/ModalBase" }, "customElement": true, "tagName": "s-modal" } ] }, { "kind": "javascript-module", "path": "dist/components/MoneyField/index.js", "declarations": [ { "kind": "class", "description": "", "name": "MoneyField", "slots": [ { "name": "error" }, { "name": "details" } ], "members": [ { "kind": "field", "name": "value", "type": { "text": "string" } }, { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "autocomplete", "type": { "text": "string" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "Infinity", "description": "The highest decimal or integer to be accepted for the field. When used with `step` the value will round down to the max number. Note: a user will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation." }, { "kind": "field", "name": "min", "type": { "text": "number" }, "default": "-Infinity", "description": "The lowest decimal or integer to be accepted for the field. When used with `step` the value will round up to the min number. Note: a user will still be able to use the keyboard to input a number lower than the min. It is up to the developer to add appropriate validation." }, { "kind": "field", "name": "currencyCode", "type": { "text": "\"auto\" | \"USD\" | \"EUR\" | \"GBP\" | \"CAD\" | \"AFN\" | \"ALL\" | \"DZD\" | \"AOA\" | \"ARS\" | \"AMD\" | \"AWG\" | \"AUD\" | \"BBD\" | \"AZN\" | \"BDT\" | \"BSD\" | \"BHD\" | \"BIF\" | \"BZD\" | \"BMD\" | \"BTN\" | \"BAM\" | \"BRL\" | \"BOB\" | \"BWP\" | \"BND\" | \"BGN\" | \"MMK\" | \"KHR\" | \"CVE\" | \"KYD\" | \"XAF\" | \"CLP\" | \"CNY\" | \"COP\" | \"KMF\" | \"CDF\" | \"CRC\" | \"HRK\" | \"CZK\" | \"DKK\" | \"DOP\" | \"XCD\" | \"EGP\" | \"ETB\" | \"XPF\" | \"FJD\" | \"GMD\" | \"GHS\" | \"GTQ\" | \"GYD\" | \"GEL\" | \"HTG\" | \"HNL\" | \"HKD\" | \"HUF\" | \"ISK\" | \"INR\" | \"IDR\" | \"ILS\" | \"IQD\" | \"JMD\" | \"JPY\" | \"JEP\" | \"JOD\" | \"KZT\" | \"KES\" | \"KWD\" | \"KGS\" | \"LAK\" | \"LVL\" | \"LBP\" | \"LSL\" | \"LRD\" | \"LTL\" | \"MGA\" | \"MKD\" | \"MOP\" | \"MWK\" | \"MVR\" | \"MXN\" | \"MYR\" | \"MUR\" | \"MDL\" | \"MAD\" | \"MNT\" | \"MZN\" | \"NAD\" | \"NPR\" | \"ANG\" | \"NZD\" | \"NIO\" | \"NGN\" | \"NOK\" | \"OMR\" | \"PAB\" | \"PKR\" | \"PGK\" | \"PYG\" | \"PEN\" | \"PHP\" | \"PLN\" | \"QAR\" | \"RON\" | \"RUB\" | \"RWF\" | \"WST\" | \"SAR\" | \"RSD\" | \"SCR\" | \"SGD\" | \"SDG\" | \"SYP\" | \"ZAR\" | \"KRW\" | \"SSP\" | \"SBD\" | \"LKR\" | \"SRD\" | \"SZL\" | \"SEK\" | \"CHF\" | \"TWD\" | \"THB\" | \"TZS\" | \"TTD\" | \"TND\" | \"TRY\" | \"TMT\" | \"UGX\" | \"UAH\" | \"AED\" | \"UYU\" | \"UZS\" | \"VUV\" | \"VND\" | \"XOF\" | \"YER\" | \"ZMW\" | \"BYN\" | \"BYR\" | \"DJF\" | \"ERN\" | \"FKP\" | \"GIP\" | \"GNF\" | \"IRR\" | \"KID\" | \"LYD\" | \"MRU\" | \"SLL\" | \"SHP\" | \"SOS\" | \"STD\" | \"STN\" | \"TJS\" | \"TOP\" | \"VED\" | \"VEF\" | \"VES\" | \"XXX\"" }, "default": "'auto'", "description": "The currency code of the field. When set to 'auto', the field will display the currency code of the shop. If no currency code is set for the shop, resolve to 'XXX' the explicit non value. This value will match the global currency code of the shop, so if you need to know the currency code of the field, you can read the value from those APIs." } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user makes changes to the field value. This fires before `onChange`." }, { "name": "change", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user has finished editing the field, such as when they blur the field." }, { "name": "focus", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field receives focus." }, { "name": "blur", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field loses focus." } ], "attributes": [ { "name": "value", "fieldName": "value", "type": { "text": "string" } }, { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "string" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "name": "max", "fieldName": "max", "type": { "text": "number" }, "default": "Infinity", "description": "The highest decimal or integer to be accepted for the field. When used with `step` the value will round down to the max number. Note: a user will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation." }, { "name": "min", "fieldName": "min", "type": { "text": "number" }, "default": "-Infinity", "description": "The lowest decimal or integer to be accepted for the field. When used with `step` the value will round up to the min number. Note: a user will still be able to use the keyboard to input a number lower than the min. It is up to the developer to add appropriate validation." }, { "name": "currencycode", "fieldName": "currencyCode", "type": { "text": "\"auto\" | \"USD\" | \"EUR\" | \"GBP\" | \"CAD\" | \"AFN\" | \"ALL\" | \"DZD\" | \"AOA\" | \"ARS\" | \"AMD\" | \"AWG\" | \"AUD\" | \"BBD\" | \"AZN\" | \"BDT\" | \"BSD\" | \"BHD\" | \"BIF\" | \"BZD\" | \"BMD\" | \"BTN\" | \"BAM\" | \"BRL\" | \"BOB\" | \"BWP\" | \"BND\" | \"BGN\" | \"MMK\" | \"KHR\" | \"CVE\" | \"KYD\" | \"XAF\" | \"CLP\" | \"CNY\" | \"COP\" | \"KMF\" | \"CDF\" | \"CRC\" | \"HRK\" | \"CZK\" | \"DKK\" | \"DOP\" | \"XCD\" | \"EGP\" | \"ETB\" | \"XPF\" | \"FJD\" | \"GMD\" | \"GHS\" | \"GTQ\" | \"GYD\" | \"GEL\" | \"HTG\" | \"HNL\" | \"HKD\" | \"HUF\" | \"ISK\" | \"INR\" | \"IDR\" | \"ILS\" | \"IQD\" | \"JMD\" | \"JPY\" | \"JEP\" | \"JOD\" | \"KZT\" | \"KES\" | \"KWD\" | \"KGS\" | \"LAK\" | \"LVL\" | \"LBP\" | \"LSL\" | \"LRD\" | \"LTL\" | \"MGA\" | \"MKD\" | \"MOP\" | \"MWK\" | \"MVR\" | \"MXN\" | \"MYR\" | \"MUR\" | \"MDL\" | \"MAD\" | \"MNT\" | \"MZN\" | \"NAD\" | \"NPR\" | \"ANG\" | \"NZD\" | \"NIO\" | \"NGN\" | \"NOK\" | \"OMR\" | \"PAB\" | \"PKR\" | \"PGK\" | \"PYG\" | \"PEN\" | \"PHP\" | \"PLN\" | \"QAR\" | \"RON\" | \"RUB\" | \"RWF\" | \"WST\" | \"SAR\" | \"RSD\" | \"SCR\" | \"SGD\" | \"SDG\" | \"SYP\" | \"ZAR\" | \"KRW\" | \"SSP\" | \"SBD\" | \"LKR\" | \"SRD\" | \"SZL\" | \"SEK\" | \"CHF\" | \"TWD\" | \"THB\" | \"TZS\" | \"TTD\" | \"TND\" | \"TRY\" | \"TMT\" | \"UGX\" | \"UAH\" | \"AED\" | \"UYU\" | \"UZS\" | \"VUV\" | \"VND\" | \"XOF\" | \"YER\" | \"ZMW\" | \"BYN\" | \"BYR\" | \"DJF\" | \"ERN\" | \"FKP\" | \"GIP\" | \"GNF\" | \"IRR\" | \"KID\" | \"LYD\" | \"MRU\" | \"SLL\" | \"SHP\" | \"SOS\" | \"STD\" | \"STN\" | \"TJS\" | \"TOP\" | \"VED\" | \"VEF\" | \"VES\" | \"XXX\"" }, "default": "'auto'", "description": "The currency code of the field. When set to 'auto', the field will display the currency code of the shop. If no currency code is set for the shop, resolve to 'XXX' the explicit non value. This value will match the global currency code of the shop, so if you need to know the currency code of the field, you can read the value from those APIs." } ], "superclass": { "name": "MoneyFieldBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/MoneyField/MoneyFieldBase" }, "customElement": true, "tagName": "s-money-field" } ] }, { "kind": "javascript-module", "path": "dist/components/NumberField/index.js", "declarations": [ { "kind": "class", "description": "", "name": "NumberField", "slots": [ { "name": "error" }, { "name": "details" } ], "members": [ { "kind": "field", "name": "value", "type": { "text": "string" } }, { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "autocomplete", "type": { "text": "\"one-time-code\" | \"cc-number\" | \"cc-csc\" | \"on\" | \"off\" | \"shipping one-time-code\" | \"billing one-time-code\" | \"shipping cc-number\" | \"shipping cc-csc\" | \"billing cc-number\" | \"billing cc-csc\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "kind": "field", "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "A value to be displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\". This cannot be edited by the user, and it isn't included in the value of the field. It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input." }, { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "A value to be displayed immediately before the editable portion of the field. This is useful for displaying an implied part of the value, such as \"https://\" or \"+353\". This cannot be edited by the user, and it isn't included in the value of the field. It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input." }, { "kind": "field", "name": "max", "type": { "text": "number" }, "default": "Infinity", "description": "The highest decimal or integer to be accepted for the field. When used with `step` the value will round down to the max number. Note: a user will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation." }, { "kind": "field", "name": "min", "type": { "text": "number" }, "default": "-Infinity", "description": "The lowest decimal or integer to be accepted for the field. When used with `step` the value will round up to the min number. Note: a user will still be able to use the keyboard to input a number lower than the min. It is up to the developer to add appropriate validation." }, { "kind": "field", "name": "step", "type": { "text": "number" }, "default": "1", "description": "The amount the value can increase or decrease by. This can be an integer or decimal. If a `max` or `min` is specified with `step` when increasing/decreasing the value via the buttons, the final value will always round to the `max` or `min` rather than the closest valid amount." }, { "kind": "field", "name": "inputMode", "type": { "text": "\"decimal\" | \"numeric\"" }, "default": "'decimal'", "description": "Sets the virtual keyboard." } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user makes changes to the field value. This fires before `onChange`." }, { "name": "change", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user has finished editing the field, such as when they blur the field." }, { "name": "focus", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field receives focus." }, { "name": "blur", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field loses focus." } ], "attributes": [ { "name": "value", "fieldName": "value", "type": { "text": "string" } }, { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "\"one-time-code\" | \"cc-number\" | \"cc-csc\" | \"on\" | \"off\" | \"shipping one-time-code\" | \"billing one-time-code\" | \"shipping cc-number\" | \"shipping cc-csc\" | \"billing cc-number\" | \"billing cc-csc\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "name": "suffix", "fieldName": "suffix", "type": { "text": "string" }, "default": "''", "description": "A value to be displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\". This cannot be edited by the user, and it isn't included in the value of the field. It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input." }, { "name": "prefix", "fieldName": "prefix", "type": { "text": "string" }, "default": "''", "description": "A value to be displayed immediately before the editable portion of the field. This is useful for displaying an implied part of the value, such as \"https://\" or \"+353\". This cannot be edited by the user, and it isn't included in the value of the field. It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input." }, { "name": "max", "fieldName": "max", "type": { "text": "number" }, "default": "Infinity", "description": "The highest decimal or integer to be accepted for the field. When used with `step` the value will round down to the max number. Note: a user will still be able to use the keyboard to input a number higher than the max. It is up to the developer to add appropriate validation." }, { "name": "min", "fieldName": "min", "type": { "text": "number" }, "default": "-Infinity", "description": "The lowest decimal or integer to be accepted for the field. When used with `step` the value will round up to the min number. Note: a user will still be able to use the keyboard to input a number lower than the min. It is up to the developer to add appropriate validation." }, { "name": "step", "fieldName": "step", "type": { "text": "number" }, "default": "1", "description": "The amount the value can increase or decrease by. This can be an integer or decimal. If a `max` or `min` is specified with `step` when increasing/decreasing the value via the buttons, the final value will always round to the `max` or `min` rather than the closest valid amount." }, { "name": "inputmode", "fieldName": "inputMode", "type": { "text": "\"decimal\" | \"numeric\"" }, "default": "'decimal'", "description": "Sets the virtual keyboard." } ], "superclass": { "name": "NumberFieldBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/NumberField/NumberFieldBase" }, "customElement": true, "tagName": "s-number-field" } ] }, { "kind": "javascript-module", "path": "dist/components/Option/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Option", "slots": [ { "name": "", "description": "The content to use as the label." } ], "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the control, disallowing any interaction." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The value used in form data when the control is checked." }, { "kind": "field", "name": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active." }, { "kind": "field", "name": "defaultSelected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active by default." } ], "attributes": [ { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the control, disallowing any interaction." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "description": "The value used in form data when the control is checked." }, { "name": "selected", "fieldName": "selected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active." }, { "name": "selected", "fieldName": "defaultSelected", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active by default." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-option" } ] }, { "kind": "javascript-module", "path": "dist/components/OptionGroup/index.js", "declarations": [ { "kind": "class", "description": "", "name": "OptionGroup", "slots": [ { "name": "", "description": "The options a user can select from. Accepts `Option` components." } ], "members": [ { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the options within this group can be selected or not." }, { "kind": "field", "name": "label", "type": { "text": "string" }, "description": "The user-facing label for this group of options." } ], "attributes": [ { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Whether the options within this group can be selected or not." }, { "name": "label", "fieldName": "label", "type": { "text": "string" }, "description": "The user-facing label for this group of options." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-option-group" } ] }, { "kind": "javascript-module", "path": "dist/components/OrderedList/index.js", "declarations": [ { "kind": "class", "description": "", "name": "OrderedList", "slots": [ { "name": "", "description": "The items of the OrderedList. Only ListItems are accepted." } ], "members": [ { "kind": "field", "name": "children", "type": { "text": "any" }, "description": "The content of the OrderededList. Accepts only `ListItem` components." }, { "kind": "field", "name": "id", "type": { "text": "string | undefined" }, "description": "A unique identifier for the element." } ], "attributes": [ { "name": "children", "fieldName": "children", "type": { "text": "any" }, "description": "The content of the OrderededList. Accepts only `ListItem` components." }, { "name": "id", "fieldName": "id", "type": { "text": "string | undefined" }, "description": "A unique identifier for the element." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-ordered-list" } ] }, { "kind": "javascript-module", "path": "dist/components/Page/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Page", "slots": [ { "name": "", "description": "The main content of the page, typically containing the primary information, forms, or interactive elements that fulfill the page's purpose." }, { "name": "aside", "description": "Supplementary content displayed in a sidebar alongside the main content. Use for related information, navigation aids, or contextual actions that support the main content. This slot is only rendered when `inlineSize` is set to `base`." }, { "name": "primary-action", "description": "The main action button displayed in the page header, representing the primary action users can take on this page. Only accepts a single button component with a `variant` of `primary`. Common examples include \"Create\", \"Save\", or \"Add\"." }, { "name": "secondary-actions", "description": "Additional action buttons displayed in the page header, providing alternative or supporting actions. Only accepts button group and button components with a `variant` of `secondary` or `auto`. These are visually de-emphasized compared to the primary action." }, { "name": "breadcrumb-actions", "description": "Navigation links that help users understand their location within the app and navigate back to parent pages. Only accepts link components. Typically displays as a back arrow or breadcrumb trail in the page header." } ], "members": [ { "kind": "field", "name": "inlineSize", "type": { "text": "\"base\" | \"small\" | \"large\"" }, "description": "The inline size of the page - `base` corresponds to a set default inline size - `large` full width with whitespace" }, { "kind": "field", "name": "heading", "type": { "text": "string" }, "description": "The main page heading" } ], "attributes": [ { "name": "inlinesize", "fieldName": "inlineSize", "type": { "text": "\"base\" | \"small\" | \"large\"" }, "description": "The inline size of the page - `base` corresponds to a set default inline size - `large` full width with whitespace" }, { "name": "heading", "fieldName": "heading", "type": { "text": "string" }, "description": "The main page heading" } ], "superclass": { "name": "PageBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Page/PageBase" }, "customElement": true, "tagName": "s-page" } ] }, { "kind": "javascript-module", "path": "dist/components/Paragraph/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Paragraph", "slots": [ { "name": "", "description": "The content of the Paragraph." } ], "members": [ { "kind": "field", "name": "color", "type": { "text": "\"subdued\" | \"base\"" }, "description": "Modify the color to be more or less intense." }, { "kind": "field", "name": "tone", "type": { "text": "\"auto\" | \"neutral\" | \"info\" | \"success\" | \"caution\" | \"warning\" | \"critical\"" }, "description": "Sets the tone of the component, based on the intention of the information being conveyed." }, { "kind": "field", "name": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "fontVariantNumeric", "type": { "text": "\"auto\" | \"normal\" | \"tabular-nums\"" }, "default": "'auto' - inherit from the parent element", "description": "Set the numeric properties of the font." }, { "kind": "field", "name": "dir", "type": { "text": "\"auto\" | \"ltr\" | \"rtl\"" }, "default": "''", "description": "Indicates the directionality of the element’s text. - `ltr`: languages written from left to right (e.g. English) - `rtl`: languages written from right to left (e.g. Arabic) - `auto`: the user agent determines the direction based on the content - `''`: direction is inherited from parent elements (equivalent to not setting the attribute)" }, { "kind": "field", "name": "lineClamp", "type": { "text": "number" }, "default": "Infinity - no truncation is applied", "description": "Truncates the text content to the specified number of lines." } ], "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "\"subdued\" | \"base\"" }, "description": "Modify the color to be more or less intense." }, { "name": "tone", "fieldName": "tone", "type": { "text": "\"auto\" | \"neutral\" | \"info\" | \"success\" | \"caution\" | \"warning\" | \"critical\"" }, "description": "Sets the tone of the component, based on the intention of the information being conveyed." }, { "name": "accessibilityvisibility", "fieldName": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "name": "fontvariantnumeric", "fieldName": "fontVariantNumeric", "type": { "text": "\"auto\" | \"normal\" | \"tabular-nums\"" }, "default": "'auto' - inherit from the parent element", "description": "Set the numeric properties of the font." }, { "name": "dir", "fieldName": "dir", "type": { "text": "\"auto\" | \"ltr\" | \"rtl\"" }, "default": "''", "description": "Indicates the directionality of the element’s text. - `ltr`: languages written from left to right (e.g. English) - `rtl`: languages written from right to left (e.g. Arabic) - `auto`: the user agent determines the direction based on the content - `''`: direction is inherited from parent elements (equivalent to not setting the attribute)" }, { "name": "lineclamp", "fieldName": "lineClamp", "type": { "text": "number" }, "default": "Infinity - no truncation is applied", "description": "Truncates the text content to the specified number of lines." } ], "superclass": { "name": "ParagraphBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Paragraph/ParagraphBase" }, "customElement": true, "tagName": "s-paragraph" } ] }, { "kind": "javascript-module", "path": "dist/components/PasswordField/index.js", "declarations": [ { "kind": "class", "description": "", "name": "PasswordField", "slots": [ { "name": "error" }, { "name": "details" } ], "members": [ { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "autocomplete", "type": { "text": "\"current-password\" | \"new-password\" | \"on\" | \"off\" | \"shipping current-password\" | \"shipping new-password\" | \"billing current-password\" | \"billing new-password\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "default": "Infinity", "description": "Specifies the maximum number of characters allowed." }, { "kind": "field", "name": "minLength", "type": { "text": "number" }, "default": "0", "description": "Specifies the min number of characters allowed." } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user makes changes to the field value. This fires before `onChange`." }, { "name": "change", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user has finished editing the field, such as when they blur the field." }, { "name": "focus", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field receives focus." }, { "name": "blur", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field loses focus." } ], "attributes": [ { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "name": "value", "fieldName": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "\"current-password\" | \"new-password\" | \"on\" | \"off\" | \"shipping current-password\" | \"shipping new-password\" | \"billing current-password\" | \"billing new-password\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "default": "Infinity", "description": "Specifies the maximum number of characters allowed." }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "default": "0", "description": "Specifies the min number of characters allowed." } ], "superclass": { "name": "PasswordFieldBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/PasswordField/PasswordFieldBase" }, "customElement": true, "tagName": "s-password-field" } ] }, { "kind": "javascript-module", "path": "dist/components/Popover/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Popover", "slots": [ { "name": "", "description": "The content displayed within the popover, which appears in an overlay positioned relative to its trigger element. Typically contains menus, action lists, or supplementary information." } ], "members": [ { "kind": "field", "name": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the block size." }, { "kind": "field", "name": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the inline size." }, { "kind": "field", "name": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the maximum block size." }, { "kind": "field", "name": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the maximum inline size." }, { "kind": "field", "name": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the minimum block size." }, { "kind": "field", "name": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the minimum inline size." } ], "events": [ { "name": "hide", "type": { "text": "CustomEvent" }, "description": "A callback fired immediately when the popover starts to hide, before any exit animation. Use to perform cleanup or save state before the popover dismisses." }, { "name": "show", "type": { "text": "CustomEvent" }, "description": "A callback fired immediately when the popover starts to show, before any entrance animation. Use to prepare content or update positioning logic." }, { "name": "afterhide", "type": { "text": "CustomEvent" }, "description": "A callback fired after the popover has fully hidden and any exit animation completes. Use to reset selections or update the trigger button state." }, { "name": "aftershow", "type": { "text": "CustomEvent" }, "description": "A callback fired after the popover has fully shown and any entrance animation completes. Use to focus an element inside the popover or announce content to screen readers." }, { "name": "toggle", "type": { "text": "Event" }, "description": "A callback fired when the popover visibility toggles. Use for unified open/close handling when you don't need separate show and hide logic." }, { "name": "aftertoggle", "type": { "text": "Event" }, "description": "A callback fired after the popover visibility toggle completes and any animation finishes. Use for post-transition updates." } ], "attributes": [ { "name": "blocksize", "fieldName": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the block size." }, { "name": "inlinesize", "fieldName": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the inline size." }, { "name": "maxblocksize", "fieldName": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the maximum block size." }, { "name": "maxinlinesize", "fieldName": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the maximum inline size." }, { "name": "minblocksize", "fieldName": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the minimum block size." }, { "name": "mininlinesize", "fieldName": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the minimum inline size." } ], "superclass": { "name": "PreactPopoverElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PreactPopoverElement" }, "customElement": true, "tagName": "s-popover" } ] }, { "kind": "javascript-module", "path": "dist/components/PressButton/index.js", "declarations": [ { "kind": "class", "description": "", "name": "PressButton", "slots": [ { "name": "", "description": "The content of the PressButton." } ], "members": [ { "kind": "field", "name": "tone", "type": { "text": "\"neutral\"" }, "description": "Sets the tone of the Button based on the intention of the information being conveyed." }, { "kind": "field", "name": "icon", "type": { "text": "\"color\" | \"info\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"channels-filled\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\"" }, "description": "The type of icon to be displayed in the Button." }, { "kind": "field", "name": "variant", "type": { "text": "\"secondary\" | \"tertiary\"" }, "description": "Changes the visual appearance of the Button." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the Button meaning it cannot be clicked or receive focus." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers. Use this when using only an icon or the Button text is not enough context for users using assistive technologies." }, { "kind": "field", "name": "inlineSize", "type": { "text": "\"auto\" | \"fill\" | \"fit-content\"" }, "default": "'auto'", "description": "The displayed inline width of the Button. - `auto`: the size of the button depends on the surface and context. - `fill`: the button will takes up 100% of the available inline size. - `fit-content`: the button will take up the minimum inline-size required to fit its content." }, { "kind": "field", "name": "lang", "type": { "text": "string" }, "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)" }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Replaces content with a loading indicator while a background action is being performed. This also disables the Button." }, { "kind": "field", "name": "pressed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the button is pressed." }, { "kind": "field", "name": "defaultPressed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the button is pressed by default." } ], "events": [ { "name": "click", "type": { "text": "CustomEvent" } }, { "name": "focus", "type": { "text": "CustomEvent" } }, { "name": "blur", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "tone", "fieldName": "tone", "type": { "text": "\"neutral\"" }, "description": "Sets the tone of the Button based on the intention of the information being conveyed." }, { "name": "icon", "fieldName": "icon", "type": { "text": "\"color\" | \"info\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"channels-filled\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\"" }, "description": "The type of icon to be displayed in the Button." }, { "name": "variant", "fieldName": "variant", "type": { "text": "\"secondary\" | \"tertiary\"" }, "description": "Changes the visual appearance of the Button." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the Button meaning it cannot be clicked or receive focus." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the Button. It will be read to users using assistive technologies such as screen readers. Use this when using only an icon or the Button text is not enough context for users using assistive technologies." }, { "name": "inlinesize", "fieldName": "inlineSize", "type": { "text": "\"auto\" | \"fill\" | \"fit-content\"" }, "default": "'auto'", "description": "The displayed inline width of the Button. - `auto`: the size of the button depends on the surface and context. - `fill`: the button will takes up 100% of the available inline size. - `fit-content`: the button will take up the minimum inline-size required to fit its content." }, { "name": "lang", "fieldName": "lang", "type": { "text": "string" }, "description": "Indicate the text language. Useful when the text is in a different language than the rest of the page. It will allow assistive technologies such as screen readers to invoke the correct pronunciation. [Reference of values](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) (\"subtag\" label)" }, { "name": "loading", "fieldName": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Replaces content with a loading indicator while a background action is being performed. This also disables the Button." }, { "name": "pressed", "fieldName": "pressed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the button is pressed." }, { "name": "pressed", "fieldName": "defaultPressed", "type": { "text": "boolean" }, "default": "false", "description": "Whether the button is pressed by default." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-press-button" } ] }, { "kind": "javascript-module", "path": "dist/components/QueryContainer/index.js", "declarations": [ { "kind": "class", "description": "", "name": "QueryContainer", "slots": [ { "name": "", "description": "The content of the container." } ], "members": [ { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "containerName", "type": { "text": "string" }, "default": "''", "description": "The name of the container, which can be used in your container queries to target this container specifically. 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`. 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." } ], "attributes": [ { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "containername", "fieldName": "containerName", "type": { "text": "string" }, "default": "''", "description": "The name of the container, which can be used in your container queries to target this container specifically. 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`. 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." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-query-container" } ] }, { "kind": "javascript-module", "path": "dist/components/ScrollBox/index.js", "declarations": [ { "kind": "class", "description": "", "name": "ScrollBox", "slots": [ { "name": "", "description": "The content of the ScrollBox." } ], "members": [ { "kind": "field", "name": "overflow", "type": { "text": "\"auto\" | \"hidden\" | \"auto auto\" | \"auto hidden\" | \"hidden auto\" | \"hidden hidden\"" }, "default": "'auto'", "description": "Sets the overflow behavior of the element." }, { "kind": "field", "name": "accessibilityRole", "type": { "text": "\"generic\" | \"region\"" }, "default": "'generic'", "description": "Sets the semantic meaning of the component's content." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label used to describe the scroll container for assistive technologies." }, { "kind": "field", "name": "snapType", "type": { "text": "\"none\" | \"mandatory\" | \"proximity\"" }, "default": "'none'", "description": "Controls scroll snap behavior." }, { "kind": "field", "name": "scrollPadding", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'base'", "description": "Offset for scroll snap alignment points." }, { "kind": "field", "name": "scrollMargin", "type": { "text": "\"0\" | \"0 0\" | \"0 0 0\" | \"0 0 0 0\"" }, "default": "'0'", "description": "Scroll margin for the element (CSS-like 1-to-4-value shorthand syntax)." }, { "kind": "field", "name": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "padding", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust the padding of all edges. [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is: - 4 values: `block-start inline-end block-end inline-start` - 3 values: `block-start inline block-end` - 2 values: `block inline` For example: - `large` means block-start, inline-end, block-end and inline-start paddings are `large`. - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`. - `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`. - `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`. A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. `padding` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "background", "type": { "text": "\"subdued\" | \"base\" | \"strong\" | \"transparent\"" }, "default": "'transparent'", "description": "Adjust the background of the component." }, { "kind": "field", "name": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size)." }, { "kind": "field", "name": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "kind": "field", "name": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "kind": "field", "name": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "kind": "field", "name": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "kind": "field", "name": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." }, { "kind": "field", "name": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size)." }, { "kind": "field", "name": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size)." }, { "kind": "field", "name": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size)." }, { "kind": "field", "name": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size)." }, { "kind": "field", "name": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size)." }, { "kind": "field", "name": "display", "type": { "text": "\"auto\" | \"none\"" }, "default": "'auto'", "description": "Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers." }, { "kind": "field", "name": "paddingBlock", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the block-padding. - `large none` means block-start padding is `large`, block-end padding is `none`. This overrides the block value of `padding`. `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlockStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-start padding. This overrides the block-start value of `paddingBlock`. `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlockEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-end padding. This overrides the block-end value of `paddingBlock`. `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInline", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the inline padding. - `large none` means inline-start padding is `large`, inline-end padding is `none`. This overrides the inline value of `padding`. `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInlineStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-start padding. This overrides the inline-start value of `paddingInline`. `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInlineEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-end padding. This overrides the inline-end value of `paddingInline`. `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." } ], "events": [ { "name": "scroll", "type": { "text": "CustomEvent" }, "description": "Callback fired when the scroll container is scrolled." }, { "name": "scrolltoedge", "type": { "text": "CustomEvent" }, "description": "Callback fired when the scroll container reaches an edge." } ], "attributes": [ { "name": "overflow", "fieldName": "overflow", "type": { "text": "\"auto\" | \"hidden\" | \"auto auto\" | \"auto hidden\" | \"hidden auto\" | \"hidden hidden\"" }, "default": "'auto'", "description": "Sets the overflow behavior of the element." }, { "name": "accessibilityrole", "fieldName": "accessibilityRole", "type": { "text": "\"generic\" | \"region\"" }, "default": "'generic'", "description": "Sets the semantic meaning of the component's content." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label used to describe the scroll container for assistive technologies." }, { "name": "snaptype", "fieldName": "snapType", "type": { "text": "\"none\" | \"mandatory\" | \"proximity\"" }, "default": "'none'", "description": "Controls scroll snap behavior." }, { "name": "scrollpadding", "fieldName": "scrollPadding", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'base'", "description": "Offset for scroll snap alignment points." }, { "name": "scrollmargin", "fieldName": "scrollMargin", "type": { "text": "\"0\" | \"0 0\" | \"0 0 0\" | \"0 0 0 0\"" }, "default": "'0'", "description": "Scroll margin for the element (CSS-like 1-to-4-value shorthand syntax)." }, { "name": "accessibilityvisibility", "fieldName": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "name": "padding", "fieldName": "padding", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust the padding of all edges. [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is: - 4 values: `block-start inline-end block-end inline-start` - 3 values: `block-start inline block-end` - 2 values: `block inline` For example: - `large` means block-start, inline-end, block-end and inline-start paddings are `large`. - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`. - `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`. - `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`. A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. `padding` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "background", "fieldName": "background", "type": { "text": "\"subdued\" | \"base\" | \"strong\" | \"transparent\"" }, "default": "'transparent'", "description": "Adjust the background of the component." }, { "name": "blocksize", "fieldName": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size)." }, { "name": "border", "fieldName": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "name": "bordercolor", "fieldName": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "name": "borderradius", "fieldName": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "name": "borderstyle", "fieldName": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "name": "borderwidth", "fieldName": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." }, { "name": "inlinesize", "fieldName": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size)." }, { "name": "maxblocksize", "fieldName": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size)." }, { "name": "maxinlinesize", "fieldName": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size)." }, { "name": "minblocksize", "fieldName": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size)." }, { "name": "mininlinesize", "fieldName": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size)." }, { "name": "display", "fieldName": "display", "type": { "text": "\"auto\" | \"none\"" }, "default": "'auto'", "description": "Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers." }, { "name": "paddingblock", "fieldName": "paddingBlock", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the block-padding. - `large none` means block-start padding is `large`, block-end padding is `none`. This overrides the block value of `padding`. `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblockstart", "fieldName": "paddingBlockStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-start padding. This overrides the block-start value of `paddingBlock`. `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblockend", "fieldName": "paddingBlockEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-end padding. This overrides the block-end value of `paddingBlock`. `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginline", "fieldName": "paddingInline", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the inline padding. - `large none` means inline-start padding is `large`, inline-end padding is `none`. This overrides the inline value of `padding`. `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginlinestart", "fieldName": "paddingInlineStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-start padding. This overrides the inline-start value of `paddingInline`. `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginlineend", "fieldName": "paddingInlineEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-end padding. This overrides the inline-end value of `paddingInline`. `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." } ], "superclass": { "name": "ScrollBoxBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/ScrollBox/ScrollBoxBase" }, "customElement": true, "tagName": "s-scroll-box" } ] }, { "kind": "javascript-module", "path": "dist/components/SearchField/index.js", "declarations": [ { "kind": "class", "description": "", "name": "SearchField", "slots": [ { "name": "error" }, { "name": "details" } ], "members": [ { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "autocomplete", "type": { "text": "\"language\" | \"organization\" | \"name\" | \"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\" | \"nickname\" | \"one-time-code\" | \"organization-title\" | \"postal-code\" | \"sex\" | \"street-address\" | \"transaction-currency\" | \"username\" | \"cc-additional-name\" | \"cc-family-name\" | \"cc-given-name\" | \"cc-name\" | \"cc-type\" | \"on\" | \"off\" | \"shipping language\" | \"shipping organization\" | \"shipping name\" | \"shipping additional-name\" | \"shipping address-level1\" | \"shipping address-level2\" | \"shipping address-level3\" | \"shipping address-level4\" | \"shipping address-line1\" | \"shipping address-line2\" | \"shipping address-line3\" | \"shipping country-name\" | \"shipping country\" | \"shipping family-name\" | \"shipping given-name\" | \"shipping honorific-prefix\" | \"shipping honorific-suffix\" | \"shipping nickname\" | \"shipping one-time-code\" | \"shipping organization-title\" | \"shipping postal-code\" | \"shipping sex\" | \"shipping street-address\" | \"shipping transaction-currency\" | \"shipping username\" | \"shipping cc-additional-name\" | \"shipping cc-family-name\" | \"shipping cc-given-name\" | \"shipping cc-name\" | \"shipping cc-type\" | \"billing language\" | \"billing organization\" | \"billing name\" | \"billing additional-name\" | \"billing address-level1\" | \"billing address-level2\" | \"billing address-level3\" | \"billing address-level4\" | \"billing address-line1\" | \"billing address-line2\" | \"billing address-line3\" | \"billing country-name\" | \"billing country\" | \"billing family-name\" | \"billing given-name\" | \"billing honorific-prefix\" | \"billing honorific-suffix\" | \"billing nickname\" | \"billing one-time-code\" | \"billing organization-title\" | \"billing postal-code\" | \"billing sex\" | \"billing street-address\" | \"billing transaction-currency\" | \"billing username\" | \"billing cc-additional-name\" | \"billing cc-family-name\" | \"billing cc-given-name\" | \"billing cc-name\" | \"billing cc-type\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "default": "Infinity", "description": "Specifies the maximum number of characters allowed." }, { "kind": "field", "name": "minLength", "type": { "text": "number" }, "default": "0", "description": "Specifies the min number of characters allowed." } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user makes changes to the field value. This fires before `onChange`." }, { "name": "change", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user has finished editing the field, such as when they blur the field." }, { "name": "focus", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field receives focus." }, { "name": "blur", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field loses focus." } ], "attributes": [ { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "name": "value", "fieldName": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "\"language\" | \"organization\" | \"name\" | \"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\" | \"nickname\" | \"one-time-code\" | \"organization-title\" | \"postal-code\" | \"sex\" | \"street-address\" | \"transaction-currency\" | \"username\" | \"cc-additional-name\" | \"cc-family-name\" | \"cc-given-name\" | \"cc-name\" | \"cc-type\" | \"on\" | \"off\" | \"shipping language\" | \"shipping organization\" | \"shipping name\" | \"shipping additional-name\" | \"shipping address-level1\" | \"shipping address-level2\" | \"shipping address-level3\" | \"shipping address-level4\" | \"shipping address-line1\" | \"shipping address-line2\" | \"shipping address-line3\" | \"shipping country-name\" | \"shipping country\" | \"shipping family-name\" | \"shipping given-name\" | \"shipping honorific-prefix\" | \"shipping honorific-suffix\" | \"shipping nickname\" | \"shipping one-time-code\" | \"shipping organization-title\" | \"shipping postal-code\" | \"shipping sex\" | \"shipping street-address\" | \"shipping transaction-currency\" | \"shipping username\" | \"shipping cc-additional-name\" | \"shipping cc-family-name\" | \"shipping cc-given-name\" | \"shipping cc-name\" | \"shipping cc-type\" | \"billing language\" | \"billing organization\" | \"billing name\" | \"billing additional-name\" | \"billing address-level1\" | \"billing address-level2\" | \"billing address-level3\" | \"billing address-level4\" | \"billing address-line1\" | \"billing address-line2\" | \"billing address-line3\" | \"billing country-name\" | \"billing country\" | \"billing family-name\" | \"billing given-name\" | \"billing honorific-prefix\" | \"billing honorific-suffix\" | \"billing nickname\" | \"billing one-time-code\" | \"billing organization-title\" | \"billing postal-code\" | \"billing sex\" | \"billing street-address\" | \"billing transaction-currency\" | \"billing username\" | \"billing cc-additional-name\" | \"billing cc-family-name\" | \"billing cc-given-name\" | \"billing cc-name\" | \"billing cc-type\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "default": "Infinity", "description": "Specifies the maximum number of characters allowed." }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "default": "0", "description": "Specifies the min number of characters allowed." } ], "superclass": { "name": "SearchFieldBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/SearchField/SearchFieldBase" }, "customElement": true, "tagName": "s-search-field" } ] }, { "kind": "javascript-module", "path": "dist/components/Section/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Section", "slots": [ { "name": "", "description": "The content of the Section." } ], "members": [ { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label used to describe the section that will be announced by assistive technologies. When no `heading` property is provided or included as a children of the Section, you **must** provide an `accessibilityLabel` to describe the Section. This is important as it allows assistive technologies to provide the right context to users." }, { "kind": "field", "name": "heading", "type": { "text": "string" }, "description": "A title that describes the content of the section." }, { "kind": "field", "name": "padding", "type": { "text": "\"base\" | \"none\"" }, "description": "Adjust the padding of all edges. - `base`: applies padding that is appropriate for the element. Note that it may result in no padding if this is the right design decision in a particular context. - `none`: removes all padding from the element. This can be useful when elements inside the Section need to span to the edge of the Section. For example, a full-width image. In this case, rely on `s-box` with a padding of 'base' to bring back the desired padding for the rest of the content." } ], "attributes": [ { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label used to describe the section that will be announced by assistive technologies. When no `heading` property is provided or included as a children of the Section, you **must** provide an `accessibilityLabel` to describe the Section. This is important as it allows assistive technologies to provide the right context to users." }, { "name": "heading", "fieldName": "heading", "type": { "text": "string" }, "description": "A title that describes the content of the section." }, { "name": "padding", "fieldName": "padding", "type": { "text": "\"base\" | \"none\"" }, "description": "Adjust the padding of all edges. - `base`: applies padding that is appropriate for the element. Note that it may result in no padding if this is the right design decision in a particular context. - `none`: removes all padding from the element. This can be useful when elements inside the Section need to span to the edge of the Section. For example, a full-width image. In this case, rely on `s-box` with a padding of 'base' to bring back the desired padding for the rest of the content." } ], "superclass": { "name": "SectionBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Section/SectionBase" }, "customElement": true, "tagName": "s-section" } ] }, { "kind": "javascript-module", "path": "dist/components/Select/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Select", "slots": [ { "name": "", "description": "The options a user can select from. Accepts `Option` and `OptionGroup` components." }, { "name": "error" }, { "name": "details" } ], "members": [ { "kind": "field", "name": "value", "type": { "text": "string" } }, { "kind": "field", "name": "icon", "type": { "text": "\"color\" | \"info\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"channels-filled\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\"" }, "description": "The type of icon to be displayed in the field." }, { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." } ], "events": [ { "name": "change", "type": { "text": "CustomEvent" } }, { "name": "input", "type": { "text": "CustomEvent" } }, { "name": "blur", "type": { "text": "CustomEvent" } }, { "name": "focus", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "value", "fieldName": "value", "type": { "text": "string" } }, { "name": "icon", "fieldName": "icon", "type": { "text": "\"color\" | \"info\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"channels-filled\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\"" }, "description": "The type of icon to be displayed in the field." }, { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." } ], "superclass": { "name": "SelectBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Select/SelectBase" }, "customElement": true, "tagName": "s-select" } ] }, { "kind": "javascript-module", "path": "dist/components/Spinner/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Spinner", "members": [ { "kind": "field", "name": "size", "type": { "text": "\"base\" | \"large\" | \"large-100\"" } }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading." } ], "attributes": [ { "name": "size", "fieldName": "size", "type": { "text": "\"base\" | \"large\" | \"large-100\"" } }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose of the progress. When set, it will be announced to users using assistive technologies and will provide them with more context. Providing an `accessibilityLabel` is recommended if there is no accompanying text describing that something is loading." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-spinner" } ] }, { "kind": "javascript-module", "path": "dist/components/Stack/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Stack", "slots": [ { "name": "", "description": "The content of the Stack." } ], "members": [ { "kind": "field", "name": "justifyContent", "type": { "text": "\"normal\" | \"stretch\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\" | \"space-between\" | \"space-around\" | \"space-evenly\"" }, "default": "'normal'", "description": "Aligns the Stack's children along the inline axis." }, { "kind": "field", "name": "alignItems", "type": { "text": "\"normal\" | \"stretch\" | \"baseline\" | \"first baseline\" | \"last baseline\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\"" }, "default": "'normal'", "description": "Aligns the Stack's children along the block axis." }, { "kind": "field", "name": "alignContent", "type": { "text": "\"normal\" | \"stretch\" | \"baseline\" | \"first baseline\" | \"last baseline\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\" | \"space-between\" | \"space-around\" | \"space-evenly\"" }, "default": "'normal'", "description": "Aligns the Stack's children along the block axis. This overrides the block value of `alignContent`." }, { "kind": "field", "name": "gap", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust spacing between elements. `gap` can either accept: - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value applied to both axes (e.g. `large-100`) - OR a pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "kind": "field", "name": "rowGap", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust spacing between elements in the block axis. This overrides the row value of `gap`. `rowGap` either accepts: - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value (e.g. `large-100`) - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "kind": "field", "name": "columnGap", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust spacing between elements in the inline axis. This overrides the column value of `gap`. `columnGap` either accepts: - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value (e.g. `large-100`) - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "kind": "field", "name": "direction", "type": { "text": "\"block\" | \"inline\"" }, "default": "'block'", "description": "Sets how the Stack's children are placed within the Stack. `direction` either accepts: - a single value either `inline` or `block` - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "kind": "field", "name": "background", "type": { "text": "\"subdued\" | \"base\" | \"strong\" | \"transparent\"" }, "default": "'transparent'", "description": "Adjust the background of the component." }, { "kind": "field", "name": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." }, { "kind": "field", "name": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "kind": "field", "name": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "kind": "field", "name": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "kind": "field", "name": "padding", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust the padding of all edges. [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is: - 4 values: `block-start inline-end block-end inline-start` - 3 values: `block-start inline block-end` - 2 values: `block inline` For example: - `large` means block-start, inline-end, block-end and inline-start paddings are `large`. - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`. - `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`. - `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`. A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. `padding` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlock", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the block-padding. - `large none` means block-start padding is `large`, block-end padding is `none`. This overrides the block value of `padding`. `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlockStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-start padding. This overrides the block-start value of `paddingBlock`. `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingBlockEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-end padding. This overrides the block-end value of `paddingBlock`. `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInline", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the inline padding. - `large none` means inline-start padding is `large`, inline-end padding is `none`. This overrides the inline value of `padding`. `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInlineStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-start padding. This overrides the inline-start value of `paddingInline`. `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "paddingInlineEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-end padding. This overrides the inline-end value of `paddingInline`. `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "kind": "field", "name": "display", "type": { "text": "\"auto\" | \"none\"" }, "default": "'auto'", "description": "Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers." }, { "kind": "field", "name": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size)." }, { "kind": "field", "name": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size)." }, { "kind": "field", "name": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size)." }, { "kind": "field", "name": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size)." }, { "kind": "field", "name": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size)." }, { "kind": "field", "name": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size)." }, { "kind": "field", "name": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context. Only use this when the element's content is not enough context for users using assistive technologies." }, { "kind": "field", "name": "accessibilityRole", "type": { "text": "\"generic\" | \"status\" | \"main\" | \"header\" | \"footer\" | \"section\" | \"region\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"alert\" | \"presentation\" | \"none\"" }, "default": "'generic'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page." }, { "kind": "field", "name": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "kind": "field", "name": "overflow", "type": { "text": "\"visible\" | \"hidden\"" }, "default": "'visible'", "description": "Sets the overflow behavior of the element. - `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse. - `visible`: the content that extends beyond the element’s container is visible." } ], "attributes": [ { "name": "justifycontent", "fieldName": "justifyContent", "type": { "text": "\"normal\" | \"stretch\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\" | \"space-between\" | \"space-around\" | \"space-evenly\"" }, "default": "'normal'", "description": "Aligns the Stack's children along the inline axis." }, { "name": "alignitems", "fieldName": "alignItems", "type": { "text": "\"normal\" | \"stretch\" | \"baseline\" | \"first baseline\" | \"last baseline\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\"" }, "default": "'normal'", "description": "Aligns the Stack's children along the block axis." }, { "name": "aligncontent", "fieldName": "alignContent", "type": { "text": "\"normal\" | \"stretch\" | \"baseline\" | \"first baseline\" | \"last baseline\" | \"center\" | \"start\" | \"end\" | \"unsafe center\" | \"unsafe start\" | \"unsafe end\" | \"safe center\" | \"safe start\" | \"safe end\" | \"space-between\" | \"space-around\" | \"space-evenly\"" }, "default": "'normal'", "description": "Aligns the Stack's children along the block axis. This overrides the block value of `alignContent`." }, { "name": "gap", "fieldName": "gap", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust spacing between elements. `gap` can either accept: - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value applied to both axes (e.g. `large-100`) - OR a pair of values (eg `large-100 large-500`) can be used to set the inline and block axes respectively - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "name": "rowgap", "fieldName": "rowGap", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust spacing between elements in the block axis. This overrides the row value of `gap`. `rowGap` either accepts: - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value (e.g. `large-100`) - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "name": "columngap", "fieldName": "columnGap", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust spacing between elements in the inline axis. This overrides the column value of `gap`. `columnGap` either accepts: - a single [SpacingKeyword](https://shopify.dev/docs/api/app-home/using-polaris-components#scale) value (e.g. `large-100`) - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "name": "direction", "fieldName": "direction", "type": { "text": "\"block\" | \"inline\"" }, "default": "'block'", "description": "Sets how the Stack's children are placed within the Stack. `direction` either accepts: - a single value either `inline` or `block` - OR a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported SpacingKeyword as a query value." }, { "name": "background", "fieldName": "background", "type": { "text": "\"subdued\" | \"base\" | \"strong\" | \"transparent\"" }, "default": "'transparent'", "description": "Adjust the background of the component." }, { "name": "borderwidth", "fieldName": "borderWidth", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty<\"base\" | \"small\" | \"small-100\" | \"large\" | \"large-100\" | \"none\">" }, "default": "'' - meaning no override", "description": "Adjust the width of the border." }, { "name": "borderstyle", "fieldName": "borderStyle", "type": { "text": "\"\" | MaybeAllValuesShorthandProperty" }, "default": "'' - meaning no override", "description": "Adjust the style of the border." }, { "name": "bordercolor", "fieldName": "borderColor", "type": { "text": "\"subdued\" | \"base\" | \"strong\"" }, "default": "'' - meaning no override", "description": "Adjust the color of the border." }, { "name": "borderradius", "fieldName": "borderRadius", "type": { "text": "MaybeAllValuesShorthandProperty" }, "default": "'none'", "description": "Adjust the radius of the border." }, { "name": "padding", "fieldName": "padding", "type": { "text": "MaybeResponsive>" }, "default": "'none'", "description": "Adjust the padding of all edges. [1-to-4-value syntax](https://developer.mozilla.org/en-US/docs/Web/CSS/Shorthand_properties#edges_of_a_box) is supported. Note that, contrary to the CSS, it uses flow-relative values and the order is: - 4 values: `block-start inline-end block-end inline-start` - 3 values: `block-start inline block-end` - 2 values: `block inline` For example: - `large` means block-start, inline-end, block-end and inline-start paddings are `large`. - `large none` means block-start and block-end paddings are `large`, inline-start and inline-end paddings are `none`. - `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`. - `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`. A padding value of `auto` will use the default padding for the closest container that has had its usual padding removed. `padding` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblock", "fieldName": "paddingBlock", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the block-padding. - `large none` means block-start padding is `large`, block-end padding is `none`. This overrides the block value of `padding`. `paddingBlock` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblockstart", "fieldName": "paddingBlockStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-start padding. This overrides the block-start value of `paddingBlock`. `paddingBlockStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddingblockend", "fieldName": "paddingBlockEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the block-end padding. This overrides the block-end value of `paddingBlock`. `paddingBlockEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginline", "fieldName": "paddingInline", "type": { "text": "MaybeResponsive<\"\" | MaybeTwoValuesShorthandProperty>" }, "default": "'' - meaning no override", "description": "Adjust the inline padding. - `large none` means inline-start padding is `large`, inline-end padding is `none`. This overrides the inline value of `padding`. `paddingInline` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginlinestart", "fieldName": "paddingInlineStart", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-start padding. This overrides the inline-start value of `paddingInline`. `paddingInlineStart` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "paddinginlineend", "fieldName": "paddingInlineEnd", "type": { "text": "\"base\" | \"small\" | \"small-500\" | \"small-400\" | \"small-300\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\" | \"large-200\" | \"large-300\" | \"large-400\" | \"large-500\" | \"none\"" }, "default": "'' - meaning no override", "description": "Adjust the inline-end padding. This overrides the inline-end value of `paddingInline`. `paddingInlineEnd` also accepts a [responsive value](https://shopify.dev/docs/api/app-home/using-polaris-components#responsive-values) string with the supported PaddingKeyword as a query value." }, { "name": "display", "fieldName": "display", "type": { "text": "\"auto\" | \"none\"" }, "default": "'auto'", "description": "Sets the outer [display](https://developer.mozilla.org/en-US/docs/Web/CSS/display) type of the component. The outer type sets a component's participation in [flow layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_flow_layout). - `auto` the component's initial value. The actual value depends on the component and context. - `none` hides the component from display and removes it from the accessibility tree, making it invisible to screen readers." }, { "name": "blocksize", "fieldName": "blockSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [block size](https://developer.mozilla.org/en-US/docs/Web/CSS/block-size)." }, { "name": "minblocksize", "fieldName": "minBlockSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size)." }, { "name": "maxblocksize", "fieldName": "maxBlockSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum block size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size)." }, { "name": "inlinesize", "fieldName": "inlineSize", "type": { "text": "\"auto\" | \"0\"" }, "default": "'auto'", "description": "Adjust the [inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/inline-size)." }, { "name": "mininlinesize", "fieldName": "minInlineSize", "type": { "text": "\"0\"" }, "default": "'0'", "description": "Adjust the [minimum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size)." }, { "name": "maxinlinesize", "fieldName": "maxInlineSize", "type": { "text": "\"none\" | \"0\"" }, "default": "'none'", "description": "Adjust the [maximum inline size](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size)." }, { "name": "accessibilityvisibility", "fieldName": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label that describes the purpose or contents of the element. When set, it will be announced to users using assistive technologies and will provide them with more context. Only use this when the element's content is not enough context for users using assistive technologies." }, { "name": "accessibilityrole", "fieldName": "accessibilityRole", "type": { "text": "\"generic\" | \"status\" | \"main\" | \"header\" | \"footer\" | \"section\" | \"region\" | \"aside\" | \"navigation\" | \"ordered-list\" | \"list-item\" | \"list-item-separator\" | \"unordered-list\" | \"separator\" | \"alert\" | \"presentation\" | \"none\"" }, "default": "'generic'", "description": "Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help users navigate the page." }, { "name": "border", "fieldName": "border", "type": { "text": "BorderShorthand" }, "default": "'none' - equivalent to `none base auto`.", "description": "Set the border via the shorthand property. This can be a size, optionally followed by a color, optionally followed by a style. If the color is not specified, it will be `base`. If the style is not specified, it will be `auto`. Values can be overridden by `borderWidth`, `borderStyle`, and `borderColor`." }, { "name": "overflow", "fieldName": "overflow", "type": { "text": "\"visible\" | \"hidden\"" }, "default": "'visible'", "description": "Sets the overflow behavior of the element. - `hidden`: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel on a mouse. - `visible`: the content that extends beyond the element’s container is visible." } ], "superclass": { "name": "BoxElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/BoxElement" }, "customElement": true, "tagName": "s-stack" } ] }, { "kind": "javascript-module", "path": "dist/components/Switch/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Switch", "members": [ { "kind": "field", "name": "value", "type": { "text": "string" } }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the control, disallowing any interaction." }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string" }, "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the control that is unique within the nearest containing `Form` component." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Visual content to use as the control label." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active." }, { "kind": "field", "name": "defaultChecked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active by default." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." } ], "events": [ { "name": "change", "type": { "text": "CustomEvent" } }, { "name": "input", "type": { "text": "CustomEvent" } }, { "name": "blur", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "value", "fieldName": "value", "type": { "text": "string" } }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the control, disallowing any interaction." }, { "name": "accessibilitylabel", "fieldName": "accessibilityLabel", "type": { "text": "string" }, "description": "A label used for users using assistive technologies like screen readers. When set, any children or `label` supplied will not be announced. This can also be used to display a control without a visual label, while still providing context to users using screen readers." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the control that is unique within the nearest containing `Form` component." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Visual content to use as the control label." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "checked", "fieldName": "checked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active." }, { "name": "checked", "fieldName": "defaultChecked", "type": { "text": "boolean" }, "default": "false", "description": "Whether the control is active by default." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." } ], "superclass": { "name": "SwitchBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Switch/SwitchBase" }, "customElement": true, "tagName": "s-switch" } ] }, { "kind": "javascript-module", "path": "dist/components/Table/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Table", "slots": [ { "name": "", "description": "The content of the Table." }, { "name": "filters", "description": "Additional filters to display in the table. For example, the `s-search-field` component can be used to filter the table data." } ], "members": [ { "kind": "field", "name": "variant", "type": { "text": "\"auto\" | \"list\"" }, "description": "Sets the layout of the Table. - `list`: The Table is displayed as a list. - `table`: The Table is displayed as a table. - `auto`: The Table is displayed as a table on wide devices and as a list on narrow devices." }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Whether the table is in a loading state, such as initial page load or loading the next page in a paginated table. When true, the table could be in an inert state, which prevents user interaction." }, { "kind": "field", "name": "paginate", "type": { "text": "boolean" }, "default": "false", "description": "Whether to use pagination controls." }, { "kind": "field", "name": "hasPreviousPage", "type": { "text": "boolean" }, "default": "false", "description": "Whether there's a previous page of data." }, { "kind": "field", "name": "hasNextPage", "type": { "text": "boolean" }, "default": "false", "description": "Whether there's an additional page of data." } ], "events": [ { "name": "nextpage", "type": { "text": "Event" }, "description": "Called when the next page button is clicked." }, { "name": "previouspage", "type": { "text": "Event" }, "description": "Called when the previous page button is clicked." } ], "attributes": [ { "name": "variant", "fieldName": "variant", "type": { "text": "\"auto\" | \"list\"" }, "description": "Sets the layout of the Table. - `list`: The Table is displayed as a list. - `table`: The Table is displayed as a table. - `auto`: The Table is displayed as a table on wide devices and as a list on narrow devices." }, { "name": "loading", "fieldName": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Whether the table is in a loading state, such as initial page load or loading the next page in a paginated table. When true, the table could be in an inert state, which prevents user interaction." }, { "name": "paginate", "fieldName": "paginate", "type": { "text": "boolean" }, "default": "false", "description": "Whether to use pagination controls." }, { "name": "haspreviouspage", "fieldName": "hasPreviousPage", "type": { "text": "boolean" }, "default": "false", "description": "Whether there's a previous page of data." }, { "name": "hasnextpage", "fieldName": "hasNextPage", "type": { "text": "boolean" }, "default": "false", "description": "Whether there's an additional page of data." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-table" } ] }, { "kind": "javascript-module", "path": "dist/components/TableBody/index.js", "declarations": [ { "kind": "class", "description": "", "name": "TableBody", "slots": [ { "name": "", "description": "The body of the table. May not have any semantic meaning in the Table's `list` variant." } ], "members": [ { "kind": "field", "name": "children", "type": { "text": "any" }, "description": "The body of the table. May not have any semantic meaning in the Table's `list` variant." }, { "kind": "field", "name": "id", "type": { "text": "string | undefined" }, "description": "A unique identifier for the element." } ], "attributes": [ { "name": "children", "fieldName": "children", "type": { "text": "any" }, "description": "The body of the table. May not have any semantic meaning in the Table's `list` variant." }, { "name": "id", "fieldName": "id", "type": { "text": "string | undefined" }, "description": "A unique identifier for the element." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-table-body" } ] }, { "kind": "javascript-module", "path": "dist/components/TableCell/index.js", "declarations": [ { "kind": "class", "description": "", "name": "TableCell", "slots": [ { "name": "", "description": "The content of the table cell." } ], "members": [ { "kind": "field", "name": "children", "type": { "text": "any" }, "description": "The content of the table cell." }, { "kind": "field", "name": "id", "type": { "text": "string | undefined" }, "description": "A unique identifier for the element." } ], "attributes": [ { "name": "children", "fieldName": "children", "type": { "text": "any" }, "description": "The content of the table cell." }, { "name": "id", "fieldName": "id", "type": { "text": "string | undefined" }, "description": "A unique identifier for the element." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-table-cell" } ] }, { "kind": "javascript-module", "path": "dist/components/TableHeader/index.js", "declarations": [ { "kind": "class", "description": "", "name": "TableHeader", "slots": [ { "name": "", "description": "The heading of the column in the `table` variant, and the label of its data in `list` variant." } ], "members": [ { "kind": "field", "name": "listSlot", "type": { "text": "\"primary\" | \"secondary\" | \"inline\" | \"kicker\" | \"labeled\"" }, "description": "Content designation for the table's `list` variant. - `primary`: The most important content. Only one column can have this designation. - `secondary`: The secondary content. Only one column can have this designation. - `kicker`: Content that is displayed before primary and secondary content, but with less visual prominence. Only one column can have this designation. - `inline`: Content that is displayed inline. - `labeled`: Each column with this designation displays as a heading-content pair." }, { "kind": "field", "name": "format", "type": { "text": "\"base\" | \"numeric\" | \"currency\"" }, "description": "The format of the column. Will automatically apply styling and alignment to cell content based on the value. - `base`: The base format for columns. - `currency`: Formats the column as currency. - `numeric`: Formats the column as a number." } ], "attributes": [ { "name": "listslot", "fieldName": "listSlot", "type": { "text": "\"primary\" | \"secondary\" | \"inline\" | \"kicker\" | \"labeled\"" }, "description": "Content designation for the table's `list` variant. - `primary`: The most important content. Only one column can have this designation. - `secondary`: The secondary content. Only one column can have this designation. - `kicker`: Content that is displayed before primary and secondary content, but with less visual prominence. Only one column can have this designation. - `inline`: Content that is displayed inline. - `labeled`: Each column with this designation displays as a heading-content pair." }, { "name": "format", "fieldName": "format", "type": { "text": "\"base\" | \"numeric\" | \"currency\"" }, "description": "The format of the column. Will automatically apply styling and alignment to cell content based on the value. - `base`: The base format for columns. - `currency`: Formats the column as currency. - `numeric`: Formats the column as a number." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-table-header" } ] }, { "kind": "javascript-module", "path": "dist/components/TableHeaderRow/index.js", "declarations": [ { "kind": "class", "description": "", "name": "TableHeaderRow", "slots": [ { "name": "", "description": "Contents of the table heading row; children should be `TableHeading` components." } ], "members": [ { "kind": "field", "name": "children", "type": { "text": "any" }, "description": "Contents of the table heading row; children should be `TableHeading` components." }, { "kind": "field", "name": "id", "type": { "text": "string | undefined" }, "description": "A unique identifier for the element." } ], "attributes": [ { "name": "children", "fieldName": "children", "type": { "text": "any" }, "description": "Contents of the table heading row; children should be `TableHeading` components." }, { "name": "id", "fieldName": "id", "type": { "text": "string | undefined" }, "description": "A unique identifier for the element." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-table-header-row" } ] }, { "kind": "javascript-module", "path": "dist/components/TableRow/index.js", "declarations": [ { "kind": "class", "description": "", "name": "TableRow", "slots": [ { "name": "", "description": "The content of a TableRow, which should be `TableCell` components." } ], "members": [ { "kind": "field", "name": "children", "type": { "text": "any" }, "description": "The content of a TableRow, which should be `TableCell` components." }, { "kind": "field", "name": "clickDelegate", "type": { "text": "string | undefined" }, "description": "The ID of an interactive element (e.g. `s-link`) in the row that will be the target of the click when the row is clicked. This is the primary action for the row; it should not be used for secondary actions. This is a click-only affordance, and does not introduce any keyboard or screen reader affordances. Which is why the target element must be in the table; so that keyboard and screen reader users can interact with it normally." } ], "attributes": [ { "name": "children", "fieldName": "children", "type": { "text": "any" }, "description": "The content of a TableRow, which should be `TableCell` components." }, { "name": "clickdelegate", "fieldName": "clickDelegate", "type": { "text": "string | undefined" }, "description": "The ID of an interactive element (e.g. `s-link`) in the row that will be the target of the click when the row is clicked. This is the primary action for the row; it should not be used for secondary actions. This is a click-only affordance, and does not introduce any keyboard or screen reader affordances. Which is why the target element must be in the table; so that keyboard and screen reader users can interact with it normally." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-table-row" } ] }, { "kind": "javascript-module", "path": "dist/components/Text/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Text", "slots": [ { "name": "", "description": "The content of the Text." } ], "members": [ { "kind": "field", "name": "color", "type": { "text": "\"subdued\" | \"base\"" }, "description": "Modify the color to be more or less intense." }, { "kind": "field", "name": "type", "type": { "text": "\"strong\" | \"address\" | \"redundant\" | \"generic\"" }, "description": "Provide semantic meaning and default styling to the text. Other presentation properties on Text override the default styling." }, { "kind": "field", "name": "tone", "type": { "text": "\"auto\" | \"neutral\" | \"info\" | \"success\" | \"caution\" | \"warning\" | \"critical\"" }, "description": "Sets the tone of the component, based on the intention of the information being conveyed." }, { "kind": "field", "name": "fontVariantNumeric", "type": { "text": "\"auto\" | \"normal\" | \"tabular-nums\"" }, "description": "Set the numeric properties of the font." }, { "kind": "field", "name": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "dir", "type": { "text": "\"auto\" | \"ltr\" | \"rtl\"" }, "default": "''", "description": "Indicates the directionality of the element’s text. - `ltr`: languages written from left to right (e.g. English) - `rtl`: languages written from right to left (e.g. Arabic) - `auto`: the user agent determines the direction based on the content - `''`: direction is inherited from parent elements (equivalent to not setting the attribute)" }, { "kind": "field", "name": "interestFor", "type": { "text": "string" }, "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component." } ], "attributes": [ { "name": "color", "fieldName": "color", "type": { "text": "\"subdued\" | \"base\"" }, "description": "Modify the color to be more or less intense." }, { "name": "type", "fieldName": "type", "type": { "text": "\"strong\" | \"address\" | \"redundant\" | \"generic\"" }, "description": "Provide semantic meaning and default styling to the text. Other presentation properties on Text override the default styling." }, { "name": "tone", "fieldName": "tone", "type": { "text": "\"auto\" | \"neutral\" | \"info\" | \"success\" | \"caution\" | \"warning\" | \"critical\"" }, "description": "Sets the tone of the component, based on the intention of the information being conveyed." }, { "name": "fontvariantnumeric", "fieldName": "fontVariantNumeric", "type": { "text": "\"auto\" | \"normal\" | \"tabular-nums\"" }, "description": "Set the numeric properties of the font." }, { "name": "accessibilityvisibility", "fieldName": "accessibilityVisibility", "type": { "text": "\"visible\" | \"hidden\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the element. - `visible`: the element is visible to all users. - `hidden`: the element is removed from the accessibility tree but remains visible. - `exclusive`: the element is visually hidden but remains in the accessibility tree." }, { "name": "dir", "fieldName": "dir", "type": { "text": "\"auto\" | \"ltr\" | \"rtl\"" }, "default": "''", "description": "Indicates the directionality of the element’s text. - `ltr`: languages written from left to right (e.g. English) - `rtl`: languages written from right to left (e.g. Arabic) - `auto`: the user agent determines the direction based on the content - `''`: direction is inherited from parent elements (equivalent to not setting the attribute)" }, { "name": "interestfor", "fieldName": "interestFor", "type": { "text": "string" }, "description": "ID of a component that should respond to interest (e.g. hover and focus) on this component." } ], "superclass": { "name": "TextBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/Text/TextBase" }, "customElement": true, "tagName": "s-text" } ] }, { "kind": "javascript-module", "path": "dist/components/TextArea/index.js", "declarations": [ { "kind": "class", "description": "", "name": "TextArea", "slots": [ { "name": "error" }, { "name": "details" } ], "members": [ { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "autocomplete", "type": { "text": "\"language\" | \"organization\" | \"name\" | \"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\" | \"nickname\" | \"one-time-code\" | \"organization-title\" | \"postal-code\" | \"sex\" | \"street-address\" | \"transaction-currency\" | \"username\" | \"cc-additional-name\" | \"cc-family-name\" | \"cc-given-name\" | \"cc-name\" | \"cc-type\" | \"on\" | \"off\" | \"shipping language\" | \"shipping organization\" | \"shipping name\" | \"shipping additional-name\" | \"shipping address-level1\" | \"shipping address-level2\" | \"shipping address-level3\" | \"shipping address-level4\" | \"shipping address-line1\" | \"shipping address-line2\" | \"shipping address-line3\" | \"shipping country-name\" | \"shipping country\" | \"shipping family-name\" | \"shipping given-name\" | \"shipping honorific-prefix\" | \"shipping honorific-suffix\" | \"shipping nickname\" | \"shipping one-time-code\" | \"shipping organization-title\" | \"shipping postal-code\" | \"shipping sex\" | \"shipping street-address\" | \"shipping transaction-currency\" | \"shipping username\" | \"shipping cc-additional-name\" | \"shipping cc-family-name\" | \"shipping cc-given-name\" | \"shipping cc-name\" | \"shipping cc-type\" | \"billing language\" | \"billing organization\" | \"billing name\" | \"billing additional-name\" | \"billing address-level1\" | \"billing address-level2\" | \"billing address-level3\" | \"billing address-level4\" | \"billing address-line1\" | \"billing address-line2\" | \"billing address-line3\" | \"billing country-name\" | \"billing country\" | \"billing family-name\" | \"billing given-name\" | \"billing honorific-prefix\" | \"billing honorific-suffix\" | \"billing nickname\" | \"billing one-time-code\" | \"billing organization-title\" | \"billing postal-code\" | \"billing sex\" | \"billing street-address\" | \"billing transaction-currency\" | \"billing username\" | \"billing cc-additional-name\" | \"billing cc-family-name\" | \"billing cc-given-name\" | \"billing cc-name\" | \"billing cc-type\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "default": "Infinity", "description": "Specifies the maximum number of characters allowed." }, { "kind": "field", "name": "minLength", "type": { "text": "number" }, "default": "0", "description": "Specifies the min number of characters allowed." }, { "kind": "field", "name": "rows", "type": { "text": "number" }, "default": "2", "description": "A number of visible text lines." } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user makes changes to the field value. This fires before `onChange`." }, { "name": "change", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user has finished editing the field, such as when they blur the field." }, { "name": "focus", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field receives focus." }, { "name": "blur", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field loses focus." } ], "attributes": [ { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "name": "value", "fieldName": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "\"language\" | \"organization\" | \"name\" | \"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\" | \"nickname\" | \"one-time-code\" | \"organization-title\" | \"postal-code\" | \"sex\" | \"street-address\" | \"transaction-currency\" | \"username\" | \"cc-additional-name\" | \"cc-family-name\" | \"cc-given-name\" | \"cc-name\" | \"cc-type\" | \"on\" | \"off\" | \"shipping language\" | \"shipping organization\" | \"shipping name\" | \"shipping additional-name\" | \"shipping address-level1\" | \"shipping address-level2\" | \"shipping address-level3\" | \"shipping address-level4\" | \"shipping address-line1\" | \"shipping address-line2\" | \"shipping address-line3\" | \"shipping country-name\" | \"shipping country\" | \"shipping family-name\" | \"shipping given-name\" | \"shipping honorific-prefix\" | \"shipping honorific-suffix\" | \"shipping nickname\" | \"shipping one-time-code\" | \"shipping organization-title\" | \"shipping postal-code\" | \"shipping sex\" | \"shipping street-address\" | \"shipping transaction-currency\" | \"shipping username\" | \"shipping cc-additional-name\" | \"shipping cc-family-name\" | \"shipping cc-given-name\" | \"shipping cc-name\" | \"shipping cc-type\" | \"billing language\" | \"billing organization\" | \"billing name\" | \"billing additional-name\" | \"billing address-level1\" | \"billing address-level2\" | \"billing address-level3\" | \"billing address-level4\" | \"billing address-line1\" | \"billing address-line2\" | \"billing address-line3\" | \"billing country-name\" | \"billing country\" | \"billing family-name\" | \"billing given-name\" | \"billing honorific-prefix\" | \"billing honorific-suffix\" | \"billing nickname\" | \"billing one-time-code\" | \"billing organization-title\" | \"billing postal-code\" | \"billing sex\" | \"billing street-address\" | \"billing transaction-currency\" | \"billing username\" | \"billing cc-additional-name\" | \"billing cc-family-name\" | \"billing cc-given-name\" | \"billing cc-name\" | \"billing cc-type\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "default": "Infinity", "description": "Specifies the maximum number of characters allowed." }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "default": "0", "description": "Specifies the min number of characters allowed." }, { "name": "rows", "fieldName": "rows", "type": { "text": "number" }, "default": "2", "description": "A number of visible text lines." } ], "superclass": { "name": "TextAreaBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/TextArea/TextAreaBase" }, "customElement": true, "tagName": "s-text-area" } ] }, { "kind": "javascript-module", "path": "dist/components/TextField/index.js", "declarations": [ { "kind": "class", "description": "", "name": "TextField", "slots": [ { "name": "accessory", "description": "The accessory to display in the text field." }, { "name": "error" }, { "name": "details" } ], "members": [ { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "autocomplete", "type": { "text": "\"language\" | \"organization\" | \"name\" | \"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\" | \"nickname\" | \"one-time-code\" | \"organization-title\" | \"postal-code\" | \"sex\" | \"street-address\" | \"transaction-currency\" | \"username\" | \"cc-additional-name\" | \"cc-family-name\" | \"cc-given-name\" | \"cc-name\" | \"cc-type\" | \"on\" | \"off\" | \"shipping language\" | \"shipping organization\" | \"shipping name\" | \"shipping additional-name\" | \"shipping address-level1\" | \"shipping address-level2\" | \"shipping address-level3\" | \"shipping address-level4\" | \"shipping address-line1\" | \"shipping address-line2\" | \"shipping address-line3\" | \"shipping country-name\" | \"shipping country\" | \"shipping family-name\" | \"shipping given-name\" | \"shipping honorific-prefix\" | \"shipping honorific-suffix\" | \"shipping nickname\" | \"shipping one-time-code\" | \"shipping organization-title\" | \"shipping postal-code\" | \"shipping sex\" | \"shipping street-address\" | \"shipping transaction-currency\" | \"shipping username\" | \"shipping cc-additional-name\" | \"shipping cc-family-name\" | \"shipping cc-given-name\" | \"shipping cc-name\" | \"shipping cc-type\" | \"billing language\" | \"billing organization\" | \"billing name\" | \"billing additional-name\" | \"billing address-level1\" | \"billing address-level2\" | \"billing address-level3\" | \"billing address-level4\" | \"billing address-line1\" | \"billing address-line2\" | \"billing address-line3\" | \"billing country-name\" | \"billing country\" | \"billing family-name\" | \"billing given-name\" | \"billing honorific-prefix\" | \"billing honorific-suffix\" | \"billing nickname\" | \"billing one-time-code\" | \"billing organization-title\" | \"billing postal-code\" | \"billing sex\" | \"billing street-address\" | \"billing transaction-currency\" | \"billing username\" | \"billing cc-additional-name\" | \"billing cc-family-name\" | \"billing cc-given-name\" | \"billing cc-name\" | \"billing cc-type\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "default": "Infinity", "description": "Specifies the maximum number of characters allowed." }, { "kind": "field", "name": "minLength", "type": { "text": "number" }, "default": "0", "description": "Specifies the min number of characters allowed." }, { "kind": "field", "name": "suffix", "type": { "text": "string" }, "default": "''", "description": "A value to be displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\". This cannot be edited by the user, and it isn't included in the value of the field. It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input." }, { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "''", "description": "A value to be displayed immediately before the editable portion of the field. This is useful for displaying an implied part of the value, such as \"https://\" or \"+353\". This cannot be edited by the user, and it isn't included in the value of the field. It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input." }, { "kind": "field", "name": "icon", "type": { "text": "\"cart-filled\" | \"home-filled\" | \"list-bulleted-filled\" | \"order-filled\" | \"person-filled\" | \"product-filled\" | \"color\" | \"info\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"channels-filled\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\" | \"alert-triangle-filled\" | \"arrow-down-right\" | \"battery-low\" | \"cart-send\" | \"complete\" | \"delivered\" | \"disabled-filled\" | \"discount-automatic\" | \"discount-remove\" | \"drawer\" | \"fav\" | \"geolocation\" | \"gift\" | \"graduation-hat\" | \"info-filled\" | \"inventory-edit\" | \"inventory-list\" | \"inventory-transfer\" | \"keypad\" | \"live-critical\" | \"live-none\" | \"menu-filled\" | \"money-split\" | \"package-cancel\" | \"package-reassign\" | \"partially-complete\" | \"phablet\" | \"point-of-sale-register\" | \"receipt-folded\" | \"reorder\" | \"savings\" | \"scan-qr-code\" | \"shipping-label-cancel\" | \"star-circle\" | \"star-half\" | \"text-indent-remove\" | \"transaction-fee-add\" | \"truck\" | \"x-circle-filled\"" }, "default": "''", "description": "The type of icon to be displayed in the field." } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user makes changes to the field value. This fires before `onChange`." }, { "name": "change", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user has finished editing the field, such as when they blur the field." }, { "name": "focus", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field receives focus." }, { "name": "blur", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field loses focus." } ], "attributes": [ { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "name": "value", "fieldName": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "\"language\" | \"organization\" | \"name\" | \"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\" | \"nickname\" | \"one-time-code\" | \"organization-title\" | \"postal-code\" | \"sex\" | \"street-address\" | \"transaction-currency\" | \"username\" | \"cc-additional-name\" | \"cc-family-name\" | \"cc-given-name\" | \"cc-name\" | \"cc-type\" | \"on\" | \"off\" | \"shipping language\" | \"shipping organization\" | \"shipping name\" | \"shipping additional-name\" | \"shipping address-level1\" | \"shipping address-level2\" | \"shipping address-level3\" | \"shipping address-level4\" | \"shipping address-line1\" | \"shipping address-line2\" | \"shipping address-line3\" | \"shipping country-name\" | \"shipping country\" | \"shipping family-name\" | \"shipping given-name\" | \"shipping honorific-prefix\" | \"shipping honorific-suffix\" | \"shipping nickname\" | \"shipping one-time-code\" | \"shipping organization-title\" | \"shipping postal-code\" | \"shipping sex\" | \"shipping street-address\" | \"shipping transaction-currency\" | \"shipping username\" | \"shipping cc-additional-name\" | \"shipping cc-family-name\" | \"shipping cc-given-name\" | \"shipping cc-name\" | \"shipping cc-type\" | \"billing language\" | \"billing organization\" | \"billing name\" | \"billing additional-name\" | \"billing address-level1\" | \"billing address-level2\" | \"billing address-level3\" | \"billing address-level4\" | \"billing address-line1\" | \"billing address-line2\" | \"billing address-line3\" | \"billing country-name\" | \"billing country\" | \"billing family-name\" | \"billing given-name\" | \"billing honorific-prefix\" | \"billing honorific-suffix\" | \"billing nickname\" | \"billing one-time-code\" | \"billing organization-title\" | \"billing postal-code\" | \"billing sex\" | \"billing street-address\" | \"billing transaction-currency\" | \"billing username\" | \"billing cc-additional-name\" | \"billing cc-family-name\" | \"billing cc-given-name\" | \"billing cc-name\" | \"billing cc-type\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "default": "Infinity", "description": "Specifies the maximum number of characters allowed." }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "default": "0", "description": "Specifies the min number of characters allowed." }, { "name": "suffix", "fieldName": "suffix", "type": { "text": "string" }, "default": "''", "description": "A value to be displayed immediately after the editable portion of the field. This is useful for displaying an implied part of the value, such as \"@shopify.com\", or \"%\". This cannot be edited by the user, and it isn't included in the value of the field. It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the suffix until the user focuses the input." }, { "name": "prefix", "fieldName": "prefix", "type": { "text": "string" }, "default": "''", "description": "A value to be displayed immediately before the editable portion of the field. This is useful for displaying an implied part of the value, such as \"https://\" or \"+353\". This cannot be edited by the user, and it isn't included in the value of the field. It may not be displayed until the user has interacted with the input. For example, an inline label may take the place of the prefix until the user focuses the input." }, { "name": "icon", "fieldName": "icon", "type": { "text": "\"cart-filled\" | \"home-filled\" | \"list-bulleted-filled\" | \"order-filled\" | \"person-filled\" | \"product-filled\" | \"color\" | \"info\" | \"adjust\" | \"affiliate\" | \"airplane\" | \"alert-bubble\" | \"alert-circle\" | \"alert-diamond\" | \"alert-location\" | \"alert-octagon\" | \"alert-octagon-filled\" | \"alert-triangle\" | \"align-horizontal-centers\" | \"app-extension\" | \"apps\" | \"archive\" | \"arrow-down\" | \"arrow-down-circle\" | \"arrow-left\" | \"arrow-left-circle\" | \"arrow-right\" | \"arrow-right-circle\" | \"arrow-up\" | \"arrow-up-circle\" | \"arrow-up-right\" | \"arrows-in-horizontal\" | \"arrows-out-horizontal\" | \"asterisk\" | \"attachment\" | \"automation\" | \"backspace\" | \"bag\" | \"bank\" | \"barcode\" | \"bill\" | \"blank\" | \"blog\" | \"bolt\" | \"bolt-filled\" | \"book\" | \"book-open\" | \"brain\" | \"bug\" | \"bullet\" | \"business-entity\" | \"button\" | \"button-press\" | \"calculator\" | \"calendar\" | \"calendar-check\" | \"calendar-compare\" | \"calendar-list\" | \"calendar-time\" | \"camera\" | \"camera-flip\" | \"caret-down\" | \"caret-left\" | \"caret-right\" | \"caret-up\" | \"cart\" | \"cart-abandoned\" | \"cart-discount\" | \"cart-down\" | \"cart-sale\" | \"cart-up\" | \"cash-dollar\" | \"cash-euro\" | \"cash-pound\" | \"cash-rupee\" | \"cash-yen\" | \"catalog-product\" | \"categories\" | \"channels\" | \"channels-filled\" | \"chart-cohort\" | \"chart-donut\" | \"chart-funnel\" | \"chart-histogram-first\" | \"chart-histogram-first-last\" | \"chart-histogram-flat\" | \"chart-histogram-full\" | \"chart-histogram-growth\" | \"chart-histogram-last\" | \"chart-histogram-second-last\" | \"chart-horizontal\" | \"chart-line\" | \"chart-popular\" | \"chart-stacked\" | \"chart-vertical\" | \"chat\" | \"chat-new\" | \"chat-referral\" | \"check\" | \"check-circle\" | \"check-circle-filled\" | \"checkbox\" | \"chevron-down\" | \"chevron-down-circle\" | \"chevron-left\" | \"chevron-left-circle\" | \"chevron-right\" | \"chevron-right-circle\" | \"chevron-up\" | \"chevron-up-circle\" | \"circle\" | \"circle-dashed\" | \"clipboard\" | \"clipboard-check\" | \"clipboard-checklist\" | \"clock\" | \"clock-list\" | \"clock-revert\" | \"code\" | \"code-add\" | \"collection\" | \"collection-featured\" | \"collection-list\" | \"collection-reference\" | \"color-none\" | \"compass\" | \"compose\" | \"confetti\" | \"connect\" | \"content\" | \"contract\" | \"corner-pill\" | \"corner-round\" | \"corner-square\" | \"credit-card\" | \"credit-card-cancel\" | \"credit-card-percent\" | \"credit-card-reader\" | \"credit-card-reader-chip\" | \"credit-card-reader-tap\" | \"credit-card-secure\" | \"credit-card-tap-chip\" | \"crop\" | \"currency-convert\" | \"cursor\" | \"cursor-banner\" | \"cursor-option\" | \"data-presentation\" | \"data-table\" | \"database\" | \"database-add\" | \"database-connect\" | \"delete\" | \"delivery\" | \"desktop\" | \"disabled\" | \"discount\" | \"discount-add\" | \"discount-code\" | \"dns-settings\" | \"dock-floating\" | \"dock-side\" | \"domain\" | \"domain-landing-page\" | \"domain-new\" | \"domain-redirect\" | \"download\" | \"drag-drop\" | \"drag-handle\" | \"duplicate\" | \"edit\" | \"email\" | \"email-follow-up\" | \"email-newsletter\" | \"enabled\" | \"enter\" | \"envelope\" | \"envelope-soft-pack\" | \"eraser\" | \"exchange\" | \"exit\" | \"export\" | \"external\" | \"eye-check-mark\" | \"eye-dropper\" | \"eye-dropper-list\" | \"eye-first\" | \"eyeglasses\" | \"favicon\" | \"file\" | \"file-list\" | \"filter\" | \"filter-active\" | \"flag\" | \"flip-horizontal\" | \"flip-vertical\" | \"flower\" | \"folder\" | \"folder-add\" | \"folder-down\" | \"folder-remove\" | \"folder-up\" | \"food\" | \"foreground\" | \"forklift\" | \"forms\" | \"games\" | \"gauge\" | \"gift-card\" | \"git-branch\" | \"git-commit\" | \"git-repository\" | \"globe\" | \"globe-asia\" | \"globe-europe\" | \"globe-lines\" | \"globe-list\" | \"grid\" | \"hashtag\" | \"hashtag-decimal\" | \"hashtag-list\" | \"heart\" | \"hide\" | \"hide-filled\" | \"home\" | \"icons\" | \"identity-card\" | \"image\" | \"image-add\" | \"image-alt\" | \"image-explore\" | \"image-magic\" | \"image-none\" | \"image-with-text-overlay\" | \"images\" | \"import\" | \"in-progress\" | \"incentive\" | \"incoming\" | \"incomplete\" | \"inheritance\" | \"inventory\" | \"inventory-updated\" | \"iq\" | \"key\" | \"keyboard\" | \"keyboard-filled\" | \"keyboard-hide\" | \"label-printer\" | \"language\" | \"language-translate\" | \"layer\" | \"layout-block\" | \"layout-buy-button\" | \"layout-buy-button-horizontal\" | \"layout-buy-button-vertical\" | \"layout-column-1\" | \"layout-columns-2\" | \"layout-columns-3\" | \"layout-footer\" | \"layout-header\" | \"layout-logo-block\" | \"layout-popup\" | \"layout-rows-2\" | \"layout-section\" | \"layout-sidebar-left\" | \"layout-sidebar-right\" | \"lightbulb\" | \"link\" | \"link-list\" | \"list-bulleted\" | \"list-numbered\" | \"live\" | \"location\" | \"location-none\" | \"lock\" | \"map\" | \"markets\" | \"markets-euro\" | \"markets-rupee\" | \"markets-yen\" | \"maximize\" | \"measurement-size\" | \"measurement-size-list\" | \"measurement-volume\" | \"measurement-volume-list\" | \"measurement-weight\" | \"measurement-weight-list\" | \"media-receiver\" | \"megaphone\" | \"mention\" | \"menu\" | \"menu-horizontal\" | \"menu-vertical\" | \"merge\" | \"metafields\" | \"metaobject\" | \"metaobject-list\" | \"metaobject-reference\" | \"microphone\" | \"microphone-muted\" | \"minimize\" | \"minus\" | \"minus-circle\" | \"mobile\" | \"money\" | \"money-none\" | \"moon\" | \"nature\" | \"note\" | \"note-add\" | \"notification\" | \"number-one\" | \"order\" | \"order-batches\" | \"order-draft\" | \"order-first\" | \"order-fulfilled\" | \"order-repeat\" | \"order-unfulfilled\" | \"orders-status\" | \"organization\" | \"outdent\" | \"outgoing\" | \"package\" | \"package-fulfilled\" | \"package-on-hold\" | \"package-returned\" | \"page\" | \"page-add\" | \"page-attachment\" | \"page-clock\" | \"page-down\" | \"page-heart\" | \"page-list\" | \"page-reference\" | \"page-remove\" | \"page-report\" | \"page-up\" | \"pagination-end\" | \"pagination-start\" | \"paint-brush-flat\" | \"paint-brush-round\" | \"paper-check\" | \"passkey\" | \"paste\" | \"pause-circle\" | \"payment\" | \"payment-capture\" | \"payout\" | \"payout-dollar\" | \"payout-euro\" | \"payout-pound\" | \"payout-rupee\" | \"payout-yen\" | \"person\" | \"person-add\" | \"person-exit\" | \"person-list\" | \"person-lock\" | \"person-remove\" | \"person-segment\" | \"personalized-text\" | \"phone\" | \"phone-down\" | \"phone-down-filled\" | \"phone-in\" | \"phone-out\" | \"pin\" | \"pin-remove\" | \"plan\" | \"play\" | \"play-circle\" | \"plus\" | \"plus-circle\" | \"plus-circle-down\" | \"plus-circle-filled\" | \"plus-circle-up\" | \"point-of-sale\" | \"price-list\" | \"print\" | \"product\" | \"product-add\" | \"product-cost\" | \"product-list\" | \"product-reference\" | \"product-remove\" | \"product-return\" | \"product-unavailable\" | \"profile\" | \"profile-filled\" | \"question-circle\" | \"question-circle-filled\" | \"radio-control\" | \"receipt\" | \"receipt-dollar\" | \"receipt-euro\" | \"receipt-paid\" | \"receipt-pound\" | \"receipt-refund\" | \"receipt-rupee\" | \"receipt-yen\" | \"receivables\" | \"redo\" | \"referral-code\" | \"refresh\" | \"remove-background\" | \"replace\" | \"replay\" | \"reset\" | \"return\" | \"reward\" | \"rocket\" | \"rotate-left\" | \"rotate-right\" | \"sandbox\" | \"save\" | \"search\" | \"search-add\" | \"search-list\" | \"search-recent\" | \"search-resource\" | \"select\" | \"send\" | \"settings\" | \"share\" | \"shield-check-mark\" | \"shield-none\" | \"shield-pending\" | \"shield-person\" | \"shipping-label\" | \"shopcodes\" | \"slideshow\" | \"smiley-happy\" | \"smiley-joy\" | \"smiley-neutral\" | \"smiley-sad\" | \"social-ad\" | \"social-post\" | \"sort\" | \"sort-ascending\" | \"sort-descending\" | \"sound\" | \"split\" | \"sports\" | \"star\" | \"star-filled\" | \"star-list\" | \"status\" | \"status-active\" | \"stop-circle\" | \"store\" | \"store-import\" | \"store-managed\" | \"store-online\" | \"sun\" | \"table\" | \"table-masonry\" | \"tablet\" | \"target\" | \"tax\" | \"team\" | \"text\" | \"text-align-center\" | \"text-align-left\" | \"text-align-right\" | \"text-block\" | \"text-bold\" | \"text-color\" | \"text-font\" | \"text-font-list\" | \"text-grammar\" | \"text-in-columns\" | \"text-in-rows\" | \"text-indent\" | \"text-italic\" | \"text-quote\" | \"text-title\" | \"text-underline\" | \"text-with-image\" | \"theme\" | \"theme-cart\" | \"theme-edit\" | \"theme-store\" | \"theme-template\" | \"three-d-environment\" | \"thumbs-down\" | \"thumbs-up\" | \"tip-jar\" | \"toggle-off\" | \"toggle-on\" | \"transaction\" | \"transaction-fee-dollar\" | \"transaction-fee-euro\" | \"transaction-fee-pound\" | \"transaction-fee-rupee\" | \"transaction-fee-yen\" | \"transfer\" | \"transfer-in\" | \"transfer-internal\" | \"transfer-out\" | \"undo\" | \"unknown-device\" | \"unlock\" | \"upload\" | \"variant\" | \"variant-list\" | \"video\" | \"video-list\" | \"view\" | \"viewport-narrow\" | \"viewport-short\" | \"viewport-tall\" | \"viewport-wide\" | \"wallet\" | \"wand\" | \"watch\" | \"wifi\" | \"work\" | \"work-list\" | \"wrench\" | \"x\" | \"x-circle\" | \"empty\" | \"alert-triangle-filled\" | \"arrow-down-right\" | \"battery-low\" | \"cart-send\" | \"complete\" | \"delivered\" | \"disabled-filled\" | \"discount-automatic\" | \"discount-remove\" | \"drawer\" | \"fav\" | \"geolocation\" | \"gift\" | \"graduation-hat\" | \"info-filled\" | \"inventory-edit\" | \"inventory-list\" | \"inventory-transfer\" | \"keypad\" | \"live-critical\" | \"live-none\" | \"menu-filled\" | \"money-split\" | \"package-cancel\" | \"package-reassign\" | \"partially-complete\" | \"phablet\" | \"point-of-sale-register\" | \"receipt-folded\" | \"reorder\" | \"savings\" | \"scan-qr-code\" | \"shipping-label-cancel\" | \"star-circle\" | \"star-half\" | \"text-indent-remove\" | \"transaction-fee-add\" | \"truck\" | \"x-circle-filled\"" }, "default": "''", "description": "The type of icon to be displayed in the field." } ], "superclass": { "name": "TextFieldBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/TextField/TextFieldBase" }, "customElement": true, "tagName": "s-text-field" } ] }, { "kind": "javascript-module", "path": "dist/components/Thumbnail/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Thumbnail", "members": [ { "kind": "field", "name": "size", "type": { "text": "\"base\" | \"small\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\"" }, "description": "Adjusts the size the product thumbnail image." }, { "kind": "field", "name": "alt", "type": { "text": "string" }, "default": "`''`", "description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more." }, { "kind": "field", "name": "src", "type": { "text": "string" }, "description": "The image source (either a remote URL or a local file resource). When the image is loading or no `src` is provided, a placeholder will be rendered." } ], "events": [ { "name": "load", "type": { "text": "CustomEvent" } }, { "name": "error", "type": { "text": "CustomEvent" } } ], "attributes": [ { "name": "size", "fieldName": "size", "type": { "text": "\"base\" | \"small\" | \"small-200\" | \"small-100\" | \"large\" | \"large-100\"" }, "description": "Adjusts the size the product thumbnail image." }, { "name": "alt", "fieldName": "alt", "type": { "text": "string" }, "default": "`''`", "description": "An alternative text description that describe the image for the reader to understand what it is about. It is extremely useful for both users using assistive technology and sighted users. A well written description provides people with visual impairments the ability to participate in consuming non-text content. When a screen readers encounters an `s-image`, the description is read and announced aloud. If an image fails to load, potentially due to a poor connection, the `alt` is displayed on screen instead. This has the benefit of letting a sighted buyer know an image was meant to load here, but as an alternative, they’re still able to consume the text content. Read [considerations when writing alternative text](https://www.shopify.com/ca/blog/image-alt-text#4) to learn more." }, { "name": "src", "fieldName": "src", "type": { "text": "string" }, "description": "The image source (either a remote URL or a local file resource). When the image is loading or no `src` is provided, a placeholder will be rendered." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-thumbnail" } ] }, { "kind": "javascript-module", "path": "dist/components/Tooltip/index.js", "declarations": [ { "kind": "class", "description": "", "name": "Tooltip", "slots": [ { "name": "", "description": "The content of the Tooltip. Only accepts `Text`, `Paragraph` components, and raw `textContent`." } ], "members": [ { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." } ], "attributes": [ { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." } ], "superclass": { "name": "PreactOverlayElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PreactOverlayElement" }, "customElement": true, "tagName": "s-tooltip" } ] }, { "kind": "javascript-module", "path": "dist/components/UnorderedList/index.js", "declarations": [ { "kind": "class", "description": "", "name": "UnorderedList", "slots": [ { "name": "", "description": "The items of the UnorderedList. Only ListItems are accepted." } ], "members": [ { "kind": "field", "name": "children", "type": { "text": "any" }, "description": "The content of the UnorderededList. Accepts only `ListItem` components." }, { "kind": "field", "name": "id", "type": { "text": "string | undefined" }, "description": "A unique identifier for the element." } ], "attributes": [ { "name": "children", "fieldName": "children", "type": { "text": "any" }, "description": "The content of the UnorderededList. Accepts only `ListItem` components." }, { "name": "id", "fieldName": "id", "type": { "text": "string | undefined" }, "description": "A unique identifier for the element." } ], "superclass": { "name": "PolarisCustomElement", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/foundational/classes/PolarisCustomElement" }, "customElement": true, "tagName": "s-unordered-list" } ] }, { "kind": "javascript-module", "path": "dist/components/URLField/index.js", "declarations": [ { "kind": "class", "description": "", "name": "URLField", "slots": [ { "name": "error" }, { "name": "details" } ], "members": [ { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "kind": "field", "name": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "kind": "field", "name": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "kind": "field", "name": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "kind": "field", "name": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "kind": "field", "name": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "kind": "field", "name": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "kind": "field", "name": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "kind": "field", "name": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "kind": "field", "name": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "kind": "field", "name": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "kind": "field", "name": "autocomplete", "type": { "text": "\"photo\" | \"url\" | \"impp\" | \"home impp\" | \"mobile impp\" | \"fax impp\" | \"pager impp\" | \"on\" | \"off\" | \"shipping photo\" | \"shipping url\" | \"shipping impp\" | \"shipping home impp\" | \"shipping mobile impp\" | \"shipping fax impp\" | \"shipping pager impp\" | \"billing photo\" | \"billing url\" | \"billing impp\" | \"billing home impp\" | \"billing mobile impp\" | \"billing fax impp\" | \"billing pager impp\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "kind": "field", "name": "maxLength", "type": { "text": "number" }, "default": "Infinity", "description": "Specifies the maximum number of characters allowed." }, { "kind": "field", "name": "minLength", "type": { "text": "number" }, "default": "0", "description": "Specifies the min number of characters allowed." } ], "events": [ { "name": "input", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user makes changes to the field value. This fires before `onChange`." }, { "name": "change", "type": { "text": "CustomEvent" }, "description": "A callback fired when the user has finished editing the field, such as when they blur the field." }, { "name": "focus", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field receives focus." }, { "name": "blur", "type": { "text": "CustomEvent" }, "description": "A callback fired when the field loses focus." } ], "attributes": [ { "name": "id", "fieldName": "id", "type": { "text": "string" }, "description": "A unique identifier for the element." }, { "name": "disabled", "fieldName": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the field, disallowing any interaction." }, { "name": "name", "fieldName": "name", "type": { "text": "string" }, "description": "An identifier for the field that is unique within the nearest containing form." }, { "name": "value", "fieldName": "value", "type": { "text": "string" }, "description": "The current value for the field. If omitted, the field will be empty." }, { "name": "value", "fieldName": "defaultValue", "type": { "text": "string" }, "description": "The default value for the field." }, { "name": "details", "fieldName": "details", "type": { "text": "any" }, "description": "Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user. This will also be exposed to screen reader users." }, { "name": "error", "fieldName": "error", "type": { "text": "any" }, "description": "Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately." }, { "name": "label", "fieldName": "label", "type": { "text": "any" }, "description": "Content to use as the field label." }, { "name": "labelaccessibilityvisibility", "fieldName": "labelAccessibilityVisibility", "type": { "text": "\"visible\" | \"exclusive\"" }, "default": "'visible'", "description": "Changes the visibility of the component's label. - `visible`: the label is visible to all users. - `exclusive`: the label is visually hidden but remains in the accessibility tree." }, { "name": "placeholder", "fieldName": "placeholder", "type": { "text": "string" }, "description": "A short hint that describes the expected value of the field." }, { "name": "readonly", "fieldName": "readOnly", "type": { "text": "boolean" }, "default": "false", "description": "The field cannot be edited by the user. It is focusable will be announced by screen readers." }, { "name": "required", "fieldName": "required", "type": { "text": "boolean" }, "default": "false", "description": "Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the `error` property." }, { "name": "autocomplete", "fieldName": "autocomplete", "type": { "text": "\"photo\" | \"url\" | \"impp\" | \"home impp\" | \"mobile impp\" | \"fax impp\" | \"pager impp\" | \"on\" | \"off\" | \"shipping photo\" | \"shipping url\" | \"shipping impp\" | \"shipping home impp\" | \"shipping mobile impp\" | \"shipping fax impp\" | \"shipping pager impp\" | \"billing photo\" | \"billing url\" | \"billing impp\" | \"billing home impp\" | \"billing mobile impp\" | \"billing fax impp\" | \"billing pager impp\"" }, "default": "'tel' for PhoneField", "description": "A hint as to the intended content of the field. When set to `on` (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents. When set to `off`, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes. Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill." }, { "name": "maxlength", "fieldName": "maxLength", "type": { "text": "number" }, "default": "Infinity", "description": "Specifies the maximum number of characters allowed." }, { "name": "minlength", "fieldName": "minLength", "type": { "text": "number" }, "default": "0", "description": "Specifies the min number of characters allowed." } ], "superclass": { "name": "URLFieldBase", "module": "//home/runner/work/world/world/libraries/javascript/polaris/admin-ui-components/src/components/URLField/URLFieldBase" }, "customElement": true, "tagName": "s-url-field" } ] } ] }